diff --git a/docs/about/_changelog.md b/docs/about/_changelog.md new file mode 100644 index 0000000..d24e7ac --- /dev/null +++ b/docs/about/_changelog.md @@ -0,0 +1,4 @@ +```{include} ../../CHANGELOG.md +:relative-docs: docs/ +:relative-images: +``` diff --git a/docs/about/_readme.md b/docs/about/_readme.md new file mode 100644 index 0000000..38b6b50 --- /dev/null +++ b/docs/about/_readme.md @@ -0,0 +1,4 @@ +```{include} ../../README.md +:relative-docs: docs/ +:relative-images: +``` diff --git a/docs/about/index.rst b/docs/about/index.rst index ad3ef0a..4f99bb3 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -1,4 +1,8 @@ 📄 About ******** -.. mdinclude:: ../../CHANGELOG.md +.. toctree:: + :maxdepth: 1 + + _readme.md + _changelog.md diff --git a/docs/conf.py b/docs/conf.py index f35327c..1fbebb6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "SPL Core" -copyright = "2023, RMT" +copyright = "2024, RMT" author = "RMT" release = "4.4.1" @@ -22,8 +22,8 @@ extensions = [] -# markdown to rst (m2r) config - @see https://pypi.org/project/m2r/ -extensions.append("m2r") +# https://myst-parser.readthedocs.io/en/latest/intro.html +extensions.append("myst_parser") # TODO: enable this extension when is is supported by readthedocs # draw.io config - @see https://pypi.org/project/sphinxcontrib-drawio/