Add doc generated from code and docstrings

GitHub: fix mxcube#804
fabcor-maxiv · Oct 13, 2023 · 5789292 · 5789292
1 parent bee4273
commit 5789292
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 1 deletion.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -19,7 +19,7 @@ build:
     - "asdf plugin add poetry"
     - "asdf install poetry latest"
     - "asdf global poetry latest"
-    - "poetry install --only docs"
+    - "poetry install --only docs,main"
     - "poetry run sphinx-build -T -E -b html -c ./docs/ ./docs/source/ ${READTHEDOCS_OUTPUT}/html/"
 
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,8 @@
 
 extensions = [
     "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
 ]
 
 root_doc = "contents"
@@ -57,4 +59,18 @@
 }
 
 
+# -- Options for sphinx.ext.autodoc ------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
+
+autodoc_default_options = {
+    'members': True,
+}
+
+
+# -- Options for sphinx.ext.autosummary --------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html
+
+autosummary_generate = True
+
+
 # EOF
diff --git a/docs/source/dev/api.rst b/docs/source/dev/api.rst
@@ -0,0 +1,15 @@
+..
+
+
+***
+API
+***
+
+.. autosummary::
+    :toctree: autosummary
+    :recursive:
+
+    mxcubecore
+
+
+..  EOF
diff --git a/docs/source/dev/autosummary/.gitignore b/docs/source/dev/autosummary/.gitignore
@@ -0,0 +1,7 @@
+#
+
+
+*
+
+
+# EOF