Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: migrate from mkdocs to sphinx #117

Open
onerandomusername opened this issue Nov 15, 2021 · 0 comments
Open

Docs: migrate from mkdocs to sphinx #117

onerandomusername opened this issue Nov 15, 2021 · 0 comments
Labels
a: documentation Related to documentation of the package s: planning Discussing details t: enhancement Changes or improvements to existing features

Comments

@onerandomusername
Copy link
Member

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 free1

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.

Footnotes

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

@onerandomusername onerandomusername added a: documentation Related to documentation of the package s: planning Discussing details t: enhancement Changes or improvements to existing features labels Nov 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: documentation Related to documentation of the package s: planning Discussing details t: enhancement Changes or improvements to existing features
Projects
None yet
Development

No branches or pull requests

1 participant