Adding sphinx autoapi

Sphinx autoapi is added, through this no manual running of sphinx-autodoc is needed.
openego · Sep 14, 2022 · 8c8e6d3 · 8c8e6d3
1 parent 9fae3ea
commit 8c8e6d3
Show file tree

Hide file tree

Showing 11 changed files with 6 additions and 299 deletions.
diff --git a/doc/api.rst b/doc/api.rst
diff --git a/doc/api/edisgo.flex_opt.rst b/doc/api/edisgo.flex_opt.rst
diff --git a/doc/api/edisgo.io.rst b/doc/api/edisgo.io.rst
diff --git a/doc/api/edisgo.network.rst b/doc/api/edisgo.network.rst
diff --git a/doc/api/edisgo.opf.rst b/doc/api/edisgo.opf.rst
diff --git a/doc/api/edisgo.tools.rst b/doc/api/edisgo.tools.rst
diff --git a/doc/api/edisgo_class.rst b/doc/api/edisgo_class.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -46,6 +46,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "autoapi.extension",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
@@ -56,6 +57,9 @@
     "sphinx.ext.extlinks",  # enables external links with a key
     "sphinx_autodoc_typehints",
 ]
+# Autoapi settings
+autoapi_type = "python"
+autoapi_dirs = ["../edisgo"]
 
 # Napoleon settings
 napoleon_google_docstring = True

diff --git a/doc/index.rst b/doc/index.rst
@@ -69,6 +69,5 @@ Contents
    definitions_and_units
    configs
    equipment
-   api
    whatsnew
    genindex
diff --git a/rtd_requirements.txt b/rtd_requirements.txt
@@ -20,3 +20,4 @@ sphinx >= 4.3.0, < 5.1.0
 sphinx_rtd_theme >=0.5.2
 sphinx-autodoc-typehints
 geopandas >= 0.9.0
+sphinx-autoapi
diff --git a/setup.py b/setup.py
@@ -72,6 +72,7 @@ def read(fname):
     "jupyter_contrib_nbextensions",
     "sphinx_rtd_theme",
     "sphinx-autodoc-typehints",
+    "sphinx-autoapi",
     "pre-commit",
     "black",
     "isort",