Add API doc

diffpy · Nov 1, 2024 · 0830256 · 0830256
1 parent f72815f
commit 0830256
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 45 deletions.
diff --git a/doc/source/api/diffpy.nmf_mapping.example_package.rst b/doc/source/api/diffpy.nmf_mapping.example_package.rst
diff --git a/doc/source/api/diffpy.nmf_mapping.rst b/doc/source/api/diffpy.nmf_mapping.rst
@@ -1,30 +1,29 @@
 :tocdepth: -1
 
-|title|
-=======
-
-.. |title| replace:: diffpy.nmf_mapping package
+diffpy.nmf-mapping package
+==========================
 
 .. automodule:: diffpy.nmf_mapping
     :members:
     :undoc-members:
     :show-inheritance:
 
-Subpackages
------------
-
-.. toctree::
-   diffpy.nmf_mapping.example_package
-
 Submodules
 ----------
 
-|module|
---------
+diffpy.nmf_mapping.nmf_mapping_code module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.nmf_mapping.nmf_mapping_code
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. |module| replace:: diffpy.nmf_mapping.example_submodule module
+diffpy.nmf_mapping.main module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: diffpy.nmf_mapping.example_submodule
+.. automodule:: diffpy.nmf_mapping.main
     :members:
     :undoc-members:
     :show-inheritance:
+