Skip to content

Commit 55170d2

Browse files
raiden00plxiaoxiang781216
authored andcommitted
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
1 parent 23e0bf5 commit 55170d2

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

Documentation/Pipfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ verify_ssl = true
77

88
[packages]
99
docutils = "==0.18.1"
10-
m2r2 = "==0.3.2"
10+
myst-parser = "*"
1111
sphinx_rtd_theme = "*"
1212
Sphinx = "~=6.0"
1313
sphinx-tabs = "*"

Documentation/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
# ones.
5454
extensions = [
5555
"sphinx_rtd_theme",
56-
"m2r2",
56+
"myst_parser",
5757
"sphinx.ext.autosectionlabel",
5858
"sphinx.ext.todo",
5959
"sphinx_tabs.tabs",
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.. mdinclude:: ../../INVIOLABLES.md
1+
.. include:: ../../INVIOLABLES.md
2+
:parser: myst_parser.sphinx_

Documentation/introduction/resources.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@ Here's a list of Apache NuttX resources that you might find helpful:
2323
Legacy README
2424
=============
2525

26-
.. mdinclude:: ../legacy_README.md
26+
.. include:: ../legacy_README.md
27+
:parser: myst_parser.sphinx_

Documentation/legacy_README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ Get help using NuttX or contribute to the project on our mailing lists:
9696

9797
## Reporting Security Issues
9898

99-
Found a vulnerability? See our security policy [here](.github/SECURITY.md).
99+
Found a vulnerability? See our security policy
100+
[here](https://github.com/apache/nuttx/blob/master/.github/SECURITY.md).
100101

101102
## Issue Tracker
102103

0 commit comments

Comments
 (0)