diff --git a/docs/conf.py b/docs/conf.py index 7e813b1..a24022e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,7 +7,7 @@ # -- General configuration --------------------------------------------------- extensions = [ - 'recommonmark', + 'myst_parser', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', ] @@ -24,3 +24,8 @@ # -- Options for HTML output ------------------------------------------------- html_theme = 'sphinx_rtd_theme' + +# -- MyST Parser configuration ----------------------------------------------- +myst_enable_extensions = [ + "colon_fence", +] diff --git a/docs/index.rst b/docs/index.rst index 51a8bf5..67d9e5b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,13 @@ Welcome to BehaveX's documentation! =================================== +.. include:: ../README.md + :parser: myst_parser + .. toctree:: :maxdepth: 2 :caption: Contents: - ../README.md - Indices and tables ================== diff --git a/docs/requirements.txt b/docs/requirements.txt index bc091ec..2a4ec96 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ -recommonmark +myst-parser sphinx sphinx_rtd_theme