discord-modmail / modmail

A Modmail bot for Discord. Allowing safe moderator conversations with server members one server at a time.
https://discord-modmail.readthedocs.io/
MIT License
15 stars 8 forks source link

Docs: migrate from mkdocs to sphinx #117

Open onerandomusername opened 3 years ago

onerandomusername commented 3 years ago

Description

Sphinx is more supported, and has more features than mkdocs. There is a wider infrastructure than mkdocs, and sphinx can do more build-time injections.

Specifically, sphinx can show a version selector and show docs of specific version for free[^1]

[^1]: Our theme actually does support a version selector, but it is not fully free.

In order to keep our docs in markdown, we are able to use MyST with Sphinx to minimize the changes required to our documentation pages. If we don't want to maintain markdown docs, it is possible to convert them to reStructured Text and then commit them as rst files.

For themes, there is a community collection of some of the themes visible at https://sphinx-themes.org/. Personally, I'm a fan of the furo theme.