From 0fdd4610ae51ebaf7f98efe7478250b9810a7d00 Mon Sep 17 00:00:00 2001 From: Massimiliano Fasi Date: Sat, 11 Jan 2025 06:43:03 +0000 Subject: [PATCH] Use MyST for parsing Markdown files in documentation --- .github/workflows/deploy_docs.yml | 3 +-- docs/source/conf.py | 2 +- docs/source/readme.rst | 3 ++- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index cc0affd..089cfb8 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -10,8 +10,7 @@ jobs: - name: Install and Build run: | - sudo apt install -y doxygen graphviz - pip install sphinx sphinx_rtd_theme breathe exhale m2r2 + sudo apt install -y doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme python3-breathe python3-exhale python3-myst-parser make docs - name: Deploy diff --git a/docs/source/conf.py b/docs/source/conf.py index 4e8e7df..792847f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,7 +34,7 @@ 'sphinx.ext.githubpages', 'breathe', 'exhale', - 'm2r2', + 'myst_parser', ] # Setup the breathe extension diff --git a/docs/source/readme.rst b/docs/source/readme.rst index 3bd447c..688bda5 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -1 +1,2 @@ -.. mdinclude:: ../../README.md +.. include:: ../../README.md + :parser: myst_parser.docutils_