nolds
nolds copied to clipboard
Decide whether to stay with Sphinx or switch to MkDocs.
We've been using Sphinx so far because it was the standard tool at the time nolds was created. Since then, MkDocs has been gaining popularity. The general argument seems to be that MkDocs is easier, and also it's easier to get it to look nice while Sphinx is more mature and has more features. Also, while MkDocs uses a different Markdown dialect than GitHub the internet agrees that reST is just weird. Switching to Markdown with Sphix should be possible using the MyST parser.
I tend to agree with the arguments in favor of MkDocs, but I would need to examine how difficult it would be to switch.
- [ ] Inspect existing docs to see how many reST features we need.
- [ ] Translate one page of the docs from Sphinx to MkDocs.
- [ ] Decide whether to do it for the rest of them.