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

Move documentation to mkdocs #242

Open
gsarti opened this issue Dec 21, 2023 · 0 comments
Open

Move documentation to mkdocs #242

gsarti opened this issue Dec 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request long shot Future direction for the development of the library

Comments

@gsarti
Copy link
Member

gsarti commented Dec 21, 2023

Description

While the current furo theme for Sphinx looks nice, we have several reasons to prefer mkdocs in the long term:

  • mkdocs has out-of-the-box support for markdown, which would simplify the writing of docstrings and doc pages for new contributors not familiar with restructured text.

  • mkdocs supports autodoc-like API documentation via mkdocstrings, including Google-style docstring support. This is quite important since the only solution to add markdown to Sphinx, i.e. MyST-Parser, does not support Google docstrings and no timeline is provided.

  • Markdown support would enable visualizing links, style etc. in docstrings via inseq.explain using rich markdown support. This is not possible with the current restructured text format.

  • Moving to markdown would also allow us to setup faqtory to start automating well-known question/issues.

Also, ReadTheDocs has out-of-the-box support for mkdocs, which would simplify the move.

Example of nice mkdocs designs:

@gsarti gsarti added documentation Improvements or additions to documentation enhancement New feature or request long shot Future direction for the development of the library labels Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request long shot Future direction for the development of the library
Projects
None yet
Development

No branches or pull requests

1 participant