From 15a31624d8f4448461b6494b21189632da6b153e Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Mon, 7 Oct 2024 14:53:44 -0400 Subject: [PATCH 1/2] adding api documentation --- .../diffpy.fourigui.src.diffpy.fourigui.rst | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 doc/source/api/diffpy.fourigui.src.diffpy.fourigui.rst diff --git a/doc/source/api/diffpy.fourigui.src.diffpy.fourigui.rst b/doc/source/api/diffpy.fourigui.src.diffpy.fourigui.rst new file mode 100644 index 0000000..5acf200 --- /dev/null +++ b/doc/source/api/diffpy.fourigui.src.diffpy.fourigui.rst @@ -0,0 +1,20 @@ +:tocdepth: -1 + +diffpy.fourigui.src.diffpy.fourigui package +=========================================== + +.. automodule:: diffpy.fourigui.src.diffpy.fourigui + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +diffpy.fourigui.src.diffpy.fourigui.fourigui module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.fourigui.src.diffpy.fourigui.fourigui + :members: + :undoc-members: + :show-inheritance: From 0a00314f9d75152edfc49aa91803780584ef3af9 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Mon, 7 Oct 2024 15:17:40 -0400 Subject: [PATCH 2/2] api docs --- .../api/diffpy.fourigui.example_package.rst | 31 ------------------- doc/source/api/diffpy.fourigui.rst | 29 +++++++---------- doc/source/api/diffpy.fourigui.src.diffpy.rst | 17 ++++++++++ doc/source/api/diffpy.fourigui.src.rst | 18 +++++++++++ 4 files changed, 46 insertions(+), 49 deletions(-) delete mode 100644 doc/source/api/diffpy.fourigui.example_package.rst create mode 100644 doc/source/api/diffpy.fourigui.src.diffpy.rst create mode 100644 doc/source/api/diffpy.fourigui.src.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..fd1d4e7 100644 --- a/doc/source/api/diffpy.fourigui.rst +++ b/doc/source/api/diffpy.fourigui.rst @@ -1,9 +1,7 @@ :tocdepth: -1 -|title| -======= - -.. |title| replace:: diffpy.fourigui package +diffpy.fourigui package +======================= .. automodule:: diffpy.fourigui :members: @@ -14,17 +12,12 @@ Subpackages ----------- .. toctree:: - diffpy.fourigui.example_package - -Submodules ----------- - -|module| --------- - -.. |module| replace:: diffpy.fourigui.example_submodule module - -.. automodule:: diffpy.fourigui.example_submodule - :members: - :undoc-members: - :show-inheritance: + :titlesonly: + + diffpy.fourigui.dist + diffpy.fourigui.requirements + diffpy.fourigui.news + diffpy.fourigui..github + diffpy.fourigui.doc + diffpy.fourigui..git + diffpy.fourigui.src diff --git a/doc/source/api/diffpy.fourigui.src.diffpy.rst b/doc/source/api/diffpy.fourigui.src.diffpy.rst new file mode 100644 index 0000000..794e5a0 --- /dev/null +++ b/doc/source/api/diffpy.fourigui.src.diffpy.rst @@ -0,0 +1,17 @@ +:tocdepth: -1 + +diffpy.fourigui.src.diffpy package +================================== + +.. automodule:: diffpy.fourigui.src.diffpy + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + + diffpy.fourigui.src.diffpy.fourigui diff --git a/doc/source/api/diffpy.fourigui.src.rst b/doc/source/api/diffpy.fourigui.src.rst new file mode 100644 index 0000000..fab1abb --- /dev/null +++ b/doc/source/api/diffpy.fourigui.src.rst @@ -0,0 +1,18 @@ +:tocdepth: -1 + +diffpy.fourigui.src package +=========================== + +.. automodule:: diffpy.fourigui.src + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + + diffpy.fourigui.src.diffpy + diffpy.fourigui.src.diffpy.fourigui.egg-info