Merge pull request #29 from bobleesj/api-doc

Cookiecutter - generate API doc
diffpy · Nov 5, 2024 · 1a0714b · 1a0714b
2 parents f72815f + d0dd44b
commit 1a0714b
Show file tree

Hide file tree

Showing 2 changed files with 12 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,28 @@
 :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: