Merge pull request #28 from cadenmyers13/api_docs

sbillinge · web-flow · commit ff9b5a523ea8 · 2024-10-09T12:30:00.000-07:00
Generate API documentation
diff --git a/doc/source/api/diffpy.fourigui.example_package.rst b/doc/source/api/diffpy.fourigui.example_package.rst
diff --git a/doc/source/api/diffpy.fourigui.rst b/doc/source/api/diffpy.fourigui.rst
@@ -1,30 +1,20 @@
 :tocdepth: -1
 
-|title|
-=======
-
-.. |title| replace:: diffpy.fourigui package
+diffpy.fourigui package
+=======================
 
 .. automodule:: diffpy.fourigui
     :members:
     :undoc-members:
     :show-inheritance:
 
-Subpackages
------------
-
-.. toctree::
-   diffpy.fourigui.example_package
-
 Submodules
 ----------
 
-|module|
---------
-
-.. |module| replace:: diffpy.fourigui.example_submodule module
+diffpy.fourigui.fourigui module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: diffpy.fourigui.example_submodule
+.. automodule:: diffpy.fourigui.fourigui
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/news/api.rst b/news/api.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* Added api documentation
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
