Skip to content

Commit

Permalink
Switch to m2r2
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarhiggott committed Oct 25, 2022
1 parent 438f08e commit 281dc1f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/sphinx_docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ sphinx_rtd_theme
numpydoc
nbsphinx
ipython
myst-parser==0.18.1
m2r2
nbsphinx-link
4 changes: 3 additions & 1 deletion docs/sphinx_docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@
"numpydoc",
"sphinx.ext.autosummary",
"nbsphinx",
"myst_parser",
"m2r2",
"nbsphinx_link"
]

source_suffix = ['.rst', '.md']

templates_path = ['_templates']
exclude_patterns = ['**.ipynb_checkpoints']

Expand Down
3 changes: 1 addition & 2 deletions docs/sphinx_docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
:Version: |version|

.. include:: ../../../README.md
:parser: myst_parser.sphinx_
.. mdinclude:: ../../../README.md

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 281dc1f

Please sign in to comment.