Merge pull request #116 from pyiron/apidoc

Add API documentation

Author: jan-janssen

docs/source/conf.py

@@ -13,7 +13,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["myst_parser"]
+extensions = ["myst_parser", 'sphinx.ext.autodoc']
 
 templates_path = ['_templates']
 exclude_patterns = []
@@ -25,3 +25,10 @@
 
 html_theme = 'alabaster'
 html_static_path = ['_static']
+
+
+# -- Generate API documentation ----------------------------------------------
+# https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html
+
+from sphinx.ext.apidoc import main
+main(['-e', '-o', 'apidoc', '../../pympipool/', '--force'])

docs/source/index.rst

@@ -36,3 +36,5 @@ Documentation
    installation
    interfaces
    development
+
+* :ref:`modindex`