-
Notifications
You must be signed in to change notification settings - Fork 190
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
Adapt docs to MyST #1245
Adapt docs to MyST #1245
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #1245 +/- ##
=======================================
Coverage 64.81% 64.81%
=======================================
Files 51 51
Lines 6002 6002
=======================================
Hits 3890 3890
Misses 2112 2112 Continue to review full report at Codecov.
|
Wondering if we should just ditch Sphinx completely and use MkDocs with MkDocStrings Might be cleaner, and then we can just use markdown everywhere. |
Tested locally, seems to be working well now I added the Still think it might be worth us moving to MkDocStrings for full markdown, but will take that after these PRs are merged (if at all..) |
Converted documentation to MyST syntax, which will enable us to write the documentation in Markdown instead of reStructuredText. There is no support for writing docstrings in Markdown with MyST currently however, see the MyST docs. The we best can get currently is having the main part of the documentation written in Markdown and continue writing the docstrings in rst until the the
sphinx
autodocs
module is flexible enough to support Markdown.PR checklist
CHANGELOG.md
is updateddocs
is updated