Switch the markdown processor for C++ to myst_parser

According to https://github.com/readthedocs/recommonmark/issues/221
recommonmark is being phased out and myst_parser is actively maintained.
This commit is contained in:
Simon Hausmann 2021-07-01 10:30:47 +02:00
parent 1b9b583e3c
commit 888a1296fe
2 changed files with 9 additions and 2 deletions

View file

@ -10,7 +10,7 @@ breathe = "*"
sphinx-rtd-theme = "*"
sphinx = "*"
exhale = "*"
recommonmark = "*"
myst_parser = "*"
sphinx-markdown-tables = "*"
[requires]

View file

@ -30,7 +30,7 @@ release = '0.1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["breathe", "recommonmark", "exhale", "sphinx_markdown_tables"]
extensions = ["breathe", "myst_parser", "exhale", "sphinx_markdown_tables"]
breathe_projects = {
"SixtyFPS": "./docs/xml"
@ -77,5 +77,12 @@ html_show_sourcelink = False
html_logo = "logo.drawio.svg"
myst_enable_extensions = [
"html_image",
]
# Annotate h1/h2 elements with anchors
myst_heading_anchors = 2
def setup(app):
app.add_css_file('theme_tweak.css')