Merge pull request #106 from yucongalicechen/cookie

Generate Package API doc
diffpy · Oct 5, 2024 · f86de7e · f86de7e
2 parents b705663 + 2ad1bc1
commit f86de7e
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 83 deletions.
diff --git a/doc/source/api/diffpy.labpdfproc.data.rst b/doc/source/api/diffpy.labpdfproc.data.rst
@@ -0,0 +1,9 @@
+:tocdepth: -1
+
+diffpy.labpdfproc.data package
+==============================
+
+.. automodule:: diffpy.labpdfproc.data
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/diffpy.labpdfproc.example_package.rst b/doc/source/api/diffpy.labpdfproc.example_package.rst
diff --git a/doc/source/api/diffpy.labpdfproc.rst b/doc/source/api/diffpy.labpdfproc.rst
@@ -8,6 +8,14 @@ diffpy.labpdfproc package
     :undoc-members:
     :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+    :titlesonly:
+
+    diffpy.labpdfproc.data
+
 Submodules
 ----------
 
@@ -27,6 +35,14 @@ diffpy.labpdfproc.tools module
     :undoc-members:
     :show-inheritance:
 
+diffpy.labpdfproc.mud_calculator module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.labpdfproc.mud_calculator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 diffpy.labpdfproc.labpdfprocapp module
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -18,8 +18,6 @@
 from importlib.metadata import version
 from pathlib import Path
 
-autodoc_mock_imports = ["diffpy.utils", "numpy"]
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use Path().resolve() to make it absolute, like shown here.

diff --git a/doc/source/installation.rst b/doc/source/installation.rst
diff --git a/doc/source/min_versions.rst b/doc/source/min_versions.rst
diff --git a/doc/source/release-history.rst b/doc/source/release-history.rst
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
diff --git a/news/api_doc.rst b/news/api_doc.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* generate package API doc
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>