Documentation: replace m2r2 with myst-parser

sphinx recommends myst-parser for markdown conversion:
https://www.sphinx-doc.org/en/master/usage/markdown.html

m2r2 is not supported for Python versions >= 3.12 so
we can't build Documentation for example on latest Arch Linux

by the way myst-parser detected a bad link to SECURITY.md that is now fixed
This commit is contained in:
raiden00pl 2024-08-29 08:55:58 +02:00 committed by Xiang Xiao
parent 23e0bf5953
commit 55170d2ca2
5 changed files with 8 additions and 5 deletions

View File

@ -7,7 +7,7 @@ verify_ssl = true
[packages] [packages]
docutils = "==0.18.1" docutils = "==0.18.1"
m2r2 = "==0.3.2" myst-parser = "*"
sphinx_rtd_theme = "*" sphinx_rtd_theme = "*"
Sphinx = "~=6.0" Sphinx = "~=6.0"
sphinx-tabs = "*" sphinx-tabs = "*"

View File

@ -53,7 +53,7 @@ version = release = "latest"
# ones. # ones.
extensions = [ extensions = [
"sphinx_rtd_theme", "sphinx_rtd_theme",
"m2r2", "myst_parser",
"sphinx.ext.autosectionlabel", "sphinx.ext.autosectionlabel",
"sphinx.ext.todo", "sphinx.ext.todo",
"sphinx_tabs.tabs", "sphinx_tabs.tabs",

View File

@ -1 +1,2 @@
.. mdinclude:: ../../INVIOLABLES.md .. include:: ../../INVIOLABLES.md
:parser: myst_parser.sphinx_

View File

@ -23,4 +23,5 @@ Here's a list of Apache NuttX resources that you might find helpful:
Legacy README Legacy README
============= =============
.. mdinclude:: ../legacy_README.md .. include:: ../legacy_README.md
:parser: myst_parser.sphinx_

View File

@ -96,7 +96,8 @@ Get help using NuttX or contribute to the project on our mailing lists:
## Reporting Security Issues ## Reporting Security Issues
Found a vulnerability? See our security policy [here](.github/SECURITY.md). Found a vulnerability? See our security policy
[here](https://github.com/apache/nuttx/blob/master/.github/SECURITY.md).
## Issue Tracker ## Issue Tracker