Pinax Moves from Sphinx to MkDocs

We have been big fans of ReadTheDocs and have hosted our documentation there since its earliest days. Sphinx was at one time the only real option for writing docs and having ReadTheDocs build and host them.

While Sphinx offers more features, MkDocs offers simplicity and familiar markup syntax. Even after years of writing docs in reStructuredText, it was still quite common to spend time looking up syntax.

This friction meant more times than not docs would just not get written. Time will tell but if we lower the friction to authoring documentation, the hope is that more documentation will get written and more will be maintained.

If you’d like to help us improve our documentation, please let us know in our Pinax Project Slack channel, make a pull request or file an issue here. Your help is greatly appreciated!

Tags

sphinx documentation mkdocs