From 24377a30aa130991e55436c108a84d28c08e54f1 Mon Sep 17 00:00:00 2001 From: Daafip Date: Fri, 8 Mar 2024 10:52:57 +0100 Subject: [PATCH] adding api ref docs --- docs/{source => }/_images/model_layout.png | Bin docs/{source => }/_static/README.rst | 0 docs/{source => }/conf.py | 4 ++-- docs/{source => }/example_model_run_HBV.ipynb | 0 docs/{source => }/index.rst | 0 docs/{source => }/model.rst | 0 6 files changed, 2 insertions(+), 2 deletions(-) rename docs/{source => }/_images/model_layout.png (100%) rename docs/{source => }/_static/README.rst (100%) rename docs/{source => }/conf.py (94%) rename docs/{source => }/example_model_run_HBV.ipynb (100%) rename docs/{source => }/index.rst (100%) rename docs/{source => }/model.rst (100%) diff --git a/docs/source/_images/model_layout.png b/docs/_images/model_layout.png similarity index 100% rename from docs/source/_images/model_layout.png rename to docs/_images/model_layout.png diff --git a/docs/source/_static/README.rst b/docs/_static/README.rst similarity index 100% rename from docs/source/_static/README.rst rename to docs/_static/README.rst diff --git a/docs/source/conf.py b/docs/conf.py similarity index 94% rename from docs/source/conf.py rename to docs/conf.py index 12b928b..46d983d 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ extensions = [ 'sphinx.ext.autodoc', - "nbsphinx" + "nbsphinx", "autoapi.extension", ] @@ -53,6 +53,6 @@ # -- Use autoapi.extension to run sphinx-apidoc ------- -autoapi_dirs = ["../../src"] +autoapi_dirs = ["../src"] autoapi_python_class_content = "both" autoapi_options = ["members", "undoc-members", "imported-members", "show-inheritance"] \ No newline at end of file diff --git a/docs/source/example_model_run_HBV.ipynb b/docs/example_model_run_HBV.ipynb similarity index 100% rename from docs/source/example_model_run_HBV.ipynb rename to docs/example_model_run_HBV.ipynb diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/source/model.rst b/docs/model.rst similarity index 100% rename from docs/source/model.rst rename to docs/model.rst