Skip to content

Commit 0fdd461

Browse files
committed
Use MyST for parsing Markdown files in documentation
1 parent 90e4955 commit 0fdd461

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

.github/workflows/deploy_docs.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ jobs:
1010

1111
- name: Install and Build
1212
run: |
13-
sudo apt install -y doxygen graphviz
14-
pip install sphinx sphinx_rtd_theme breathe exhale m2r2
13+
sudo apt install -y doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme python3-breathe python3-exhale python3-myst-parser
1514
make docs
1615
1716
- name: Deploy

docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
'sphinx.ext.githubpages',
3535
'breathe',
3636
'exhale',
37-
'm2r2',
37+
'myst_parser',
3838
]
3939

4040
# Setup the breathe extension

docs/source/readme.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.. mdinclude:: ../../README.md
1+
.. include:: ../../README.md
2+
:parser: myst_parser.docutils_

0 commit comments

Comments
 (0)