From a2a2070afae04f82e84ad1516e2cd8291807ca5c Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Tue, 8 Oct 2024 11:16:28 -0400 Subject: [PATCH 1/2] api doc generating --- .../api/diffpy.fourigui.example_package.rst | 31 ------------------- doc/source/api/diffpy.fourigui.rst | 20 +++--------- 2 files changed, 5 insertions(+), 46 deletions(-) delete mode 100644 doc/source/api/diffpy.fourigui.example_package.rst diff --git a/doc/source/api/diffpy.fourigui.example_package.rst b/doc/source/api/diffpy.fourigui.example_package.rst deleted file mode 100644 index 026f516..0000000 --- a/doc/source/api/diffpy.fourigui.example_package.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _example_package documentation: - -|title| -======= - -.. |title| replace:: diffpy.fourigui.example_package package - -.. automodule:: diffpy.fourigui.example_package - :members: - :undoc-members: - :show-inheritance: - -|foo| ------ - -.. |foo| replace:: diffpy.fourigui.example_package.foo module - -.. automodule:: diffpy.fourigui.example_package.foo - :members: - :undoc-members: - :show-inheritance: - -|bar| ------ - -.. |bar| replace:: diffpy.fourigui.example_package.bar module - -.. automodule:: diffpy.fourigui.example_package.foo - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/diffpy.fourigui.rst b/doc/source/api/diffpy.fourigui.rst index 41b74f7..b83d1cb 100644 --- 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: From 165a9b1adb808df266e8472ae80168a698367cdf Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Tue, 8 Oct 2024 11:17:31 -0400 Subject: [PATCH 2/2] api news --- news/api.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/api.rst diff --git a/news/api.rst b/news/api.rst new file mode 100644 index 0000000..e4515d0 --- /dev/null +++ b/news/api.rst @@ -0,0 +1,23 @@ +**Added:** + +* Added api documentation + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*