Update docs for api

stefanDeveloper · Mar 25, 2024 · bcab8f1 · bcab8f1
1 parent a219f90
commit bcab8f1
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
+sphinxcontrib.apidoc==0.5.0
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -12,13 +12,30 @@
 # -- General configuration
 
 extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
     'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
+    'sphinxcontrib.apidoc',  # automatically generate API docs, see https://github.com/rtfd/readthedocs.org/issues/1139
+    'nbsphinx',
+    'myst_parser',
+    'sphinx_design',
 ]
 
+# -- apidoc settings ---------------------------------------------------------
+apidoc_module_dir = '../../heidgaf'
+apidoc_output_dir = 'api'
+apidoc_excluded_paths = ['**/*test*']
+apidoc_module_first = True
+apidoc_separate_modules = True
+apidoc_extra_args = ['-d 6']
+
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),
     'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
@@ -33,3 +50,5 @@
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
+
+language = "en"