From a93e246ac0b01937d3a7ee41a11555db8bfd4f06 Mon Sep 17 00:00:00 2001 From: yucongalicechen Date: Fri, 4 Oct 2024 16:16:15 -0400 Subject: [PATCH 1/2] add api workflow --- .../api/diffpy.labpdfproc.example_package.rst | 31 ------------------- doc/source/api/diffpy.labpdfproc.rst | 16 ++++++++++ 2 files changed, 16 insertions(+), 31 deletions(-) delete mode 100644 doc/source/api/diffpy.labpdfproc.example_package.rst diff --git a/doc/source/api/diffpy.labpdfproc.example_package.rst b/doc/source/api/diffpy.labpdfproc.example_package.rst deleted file mode 100644 index 429ad23..0000000 --- a/doc/source/api/diffpy.labpdfproc.example_package.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _example_package documentation: - -|title| -======= - -.. |title| replace:: diffpy.labpdfproc.example_package package - -.. automodule:: diffpy.labpdfproc.example_package - :members: - :undoc-members: - :show-inheritance: - -|foo| ------ - -.. |foo| replace:: diffpy.labpdfproc.example_package.foo module - -.. automodule:: diffpy.labpdfproc.example_package.foo - :members: - :undoc-members: - :show-inheritance: - -|bar| ------ - -.. |bar| replace:: diffpy.labpdfproc.example_package.bar module - -.. automodule:: diffpy.labpdfproc.example_package.foo - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/diffpy.labpdfproc.rst b/doc/source/api/diffpy.labpdfproc.rst index 4f0a72d..941776e 100644 --- a/doc/source/api/diffpy.labpdfproc.rst +++ b/doc/source/api/diffpy.labpdfproc.rst @@ -8,6 +8,14 @@ diffpy.labpdfproc package :undoc-members: :show-inheritance: +Subpackages +----------- + +.. toctree:: + :titlesonly: + + diffpy.labpdfproc.data + Submodules ---------- @@ -27,6 +35,14 @@ diffpy.labpdfproc.tools module :undoc-members: :show-inheritance: +diffpy.labpdfproc.mud_calculator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.labpdfproc.mud_calculator + :members: + :undoc-members: + :show-inheritance: + diffpy.labpdfproc.labpdfprocapp module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From e9fdf29f5921468c5c4c77197c0144e433830606 Mon Sep 17 00:00:00 2001 From: yucongalicechen Date: Fri, 4 Oct 2024 16:25:07 -0400 Subject: [PATCH 2/2] add news item --- news/api_doc.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/api_doc.rst diff --git a/news/api_doc.rst b/news/api_doc.rst new file mode 100644 index 0000000..5c301ef --- /dev/null +++ b/news/api_doc.rst @@ -0,0 +1,23 @@ +**Added:** + +* generate package API doc + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*