From 083025669e28563d5cabf85cb44057523848c2cf Mon Sep 17 00:00:00 2001
From: Sangjoon Bob Lee <bobleesj@gmail.com>
Date: Fri, 1 Nov 2024 15:32:44 -0400
Subject: [PATCH 1/2] Add API doc

---
 .../diffpy.nmf_mapping.example_package.rst    | 31 -------------------
 doc/source/api/diffpy.nmf_mapping.rst         | 27 ++++++++--------
 2 files changed, 13 insertions(+), 45 deletions(-)
 delete mode 100644 doc/source/api/diffpy.nmf_mapping.example_package.rst

diff --git a/doc/source/api/diffpy.nmf_mapping.example_package.rst b/doc/source/api/diffpy.nmf_mapping.example_package.rst
deleted file mode 100644
index da17a67..0000000
--- a/doc/source/api/diffpy.nmf_mapping.example_package.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. _example_package documentation:
-
-|title|
-=======
-
-.. |title| replace:: diffpy.nmf_mapping.example_package package
-
-.. automodule:: diffpy.nmf_mapping.example_package
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-|foo|
------
-
-.. |foo| replace:: diffpy.nmf_mapping.example_package.foo module
-
-.. automodule::  diffpy.nmf_mapping.example_package.foo
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-|bar|
------
-
-.. |bar| replace:: diffpy.nmf_mapping.example_package.bar module
-
-.. automodule:: diffpy.nmf_mapping.example_package.foo
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/doc/source/api/diffpy.nmf_mapping.rst b/doc/source/api/diffpy.nmf_mapping.rst
index 0f03d4b..0ca6049 100644
--- 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:
+

From d0dd44b62ac8343078a4f91399c6457abb0a26ff Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Fri, 1 Nov 2024 19:34:54 +0000
Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit hooks

---
 doc/source/api/diffpy.nmf_mapping.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/doc/source/api/diffpy.nmf_mapping.rst b/doc/source/api/diffpy.nmf_mapping.rst
index 0ca6049..2a1d507 100644
--- a/doc/source/api/diffpy.nmf_mapping.rst
+++ b/doc/source/api/diffpy.nmf_mapping.rst
@@ -26,4 +26,3 @@ diffpy.nmf_mapping.main module
     :members:
     :undoc-members:
     :show-inheritance:
-