Merge pull request #106 from yucongalicechen/cookie

Generate Package API doc

Author: sbillinge

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:

doc/source/api/diffpy.labpdfproc.example_package.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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

doc/source/api/diffpy.labpdfproc.rst

@@ -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.

doc/source/conf.py

@@ -0,0 +1,23 @@
+**Added:**
+
+* generate package API doc
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>