From a0062a5c4735c9c47e59efae8b419b9144abbbbf Mon Sep 17 00:00:00 2001 From: gubaidulinvadim <gubaidulinvadim@gmail.com> Date: Mon, 13 May 2024 20:02:05 +0200 Subject: [PATCH] added myst_parser extension for sphynx build to include README.md --- docs/source/conf.py | 1 + docs/source/readme_link.md | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 docs/source/readme_link.md diff --git a/docs/source/conf.py b/docs/source/conf.py index 16da167..feb3b08 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -36,6 +36,7 @@ release = '0.6.0' extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', + 'myst_parser' ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/readme_link.md b/docs/source/readme_link.md new file mode 100644 index 0000000..060259b --- /dev/null +++ b/docs/source/readme_link.md @@ -0,0 +1,2 @@ +```{include} ../../README.md +``` \ No newline at end of file -- GitLab