From b97b1925a693c07c7b70f0f668715310f97e04e9 Mon Sep 17 00:00:00 2001 From: JessicaJohnBritto <79603974+JessicaJohnBritto@users.noreply.github.com> Date: Thu, 19 Sep 2024 16:03:07 +0530 Subject: [PATCH] minor changes --- docs/.ipynb_checkpoints/requirements-checkpoint.txt | 1 + docs/requirements.txt | 1 + docs/source/.ipynb_checkpoints/conf-checkpoint.py | 3 ++- docs/source/.ipynb_checkpoints/index-checkpoint.rst | 6 +++++- docs/source/.ipynb_checkpoints/readme-checkpoint.rst | 1 + docs/source/conf.py | 3 ++- docs/source/index.rst | 6 +++++- docs/source/readme.rst | 1 + 8 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 docs/source/.ipynb_checkpoints/readme-checkpoint.rst create mode 100644 docs/source/readme.rst diff --git a/docs/.ipynb_checkpoints/requirements-checkpoint.txt b/docs/.ipynb_checkpoints/requirements-checkpoint.txt index fa837e0..919927b 100644 --- a/docs/.ipynb_checkpoints/requirements-checkpoint.txt +++ b/docs/.ipynb_checkpoints/requirements-checkpoint.txt @@ -4,3 +4,4 @@ numpy scipy matplotlib myst_parser +m2r2 diff --git a/docs/requirements.txt b/docs/requirements.txt index fa837e0..919927b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,3 +4,4 @@ numpy scipy matplotlib myst_parser +m2r2 diff --git a/docs/source/.ipynb_checkpoints/conf-checkpoint.py b/docs/source/.ipynb_checkpoints/conf-checkpoint.py index 14525bc..5815d7e 100644 --- a/docs/source/.ipynb_checkpoints/conf-checkpoint.py +++ b/docs/source/.ipynb_checkpoints/conf-checkpoint.py @@ -50,7 +50,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'myst_parser', + # 'myst_parser', + 'm2r2', 'sphinx.ext.todo', # Support for TODO notes # 'sphinx.ext.napoleon', # Supports Google and NumPy style docstrings 'sphinx.ext.viewcode', # Add links to highlighted source code diff --git a/docs/source/.ipynb_checkpoints/index-checkpoint.rst b/docs/source/.ipynb_checkpoints/index-checkpoint.rst index 3ad20cb..e253d70 100644 --- a/docs/source/.ipynb_checkpoints/index-checkpoint.rst +++ b/docs/source/.ipynb_checkpoints/index-checkpoint.rst @@ -6,7 +6,11 @@ Welcome to WalshPulSeqProtocol's documentation! =============================================== -.. include:: ../README.md +.. toctree:: + :maxdepth: 2 + :caption: Homepage: + + readme .. toctree:: :maxdepth: 2 diff --git a/docs/source/.ipynb_checkpoints/readme-checkpoint.rst b/docs/source/.ipynb_checkpoints/readme-checkpoint.rst new file mode 100644 index 0000000..3bd447c --- /dev/null +++ b/docs/source/.ipynb_checkpoints/readme-checkpoint.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../README.md diff --git a/docs/source/conf.py b/docs/source/conf.py index 14525bc..5815d7e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -50,7 +50,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'myst_parser', + # 'myst_parser', + 'm2r2', 'sphinx.ext.todo', # Support for TODO notes # 'sphinx.ext.napoleon', # Supports Google and NumPy style docstrings 'sphinx.ext.viewcode', # Add links to highlighted source code diff --git a/docs/source/index.rst b/docs/source/index.rst index 3ad20cb..e253d70 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,7 +6,11 @@ Welcome to WalshPulSeqProtocol's documentation! =============================================== -.. include:: ../README.md +.. toctree:: + :maxdepth: 2 + :caption: Homepage: + + readme .. toctree:: :maxdepth: 2 diff --git a/docs/source/readme.rst b/docs/source/readme.rst new file mode 100644 index 0000000..3bd447c --- /dev/null +++ b/docs/source/readme.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../README.md