You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Considering our primary document hosting sources (Github, Github Pages and ReadTheDocs) all support Markdown in some shape or form, it is worth migrating our default sphinx documents over to Markdown by default and using the MyST package.
Rename files from *.rst to *.md
Reformat index.rst in to markdown
Add myst-parser as a docs dependency in pyproject.toml
Configure myst-parser and exclude .venv in conf.py
The text was updated successfully, but these errors were encountered:
One thing that should be noted with this is that myst-parser still expects docstrings to be written in reStructuredText when using sphinx.ext.autodoc as detailed here. This is a myst-parser limitation outlined in Github issue #228.
Considering our primary document hosting sources (
Github
,Github Pages
andReadTheDocs
) all support Markdown in some shape or form, it is worth migrating our default sphinx documents over to Markdown by default and using the MyST package.index.rst
in to markdownmyst-parser
as a docs dependency inpyproject.toml
myst-parser
and exclude.venv
inconf.py
The text was updated successfully, but these errors were encountered: