From 34261a1e8eae1b0e99ebd464c94fa47f34a4a766 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Mon, 16 Sep 2024 15:32:36 -0400 Subject: [PATCH 1/2] Include api doc --- doc/source/api/diffpy.utils.parsers.rst | 28 ++++++++++++------ doc/source/api/diffpy.utils.rst | 5 +++- .../api/diffpy.utils.scattering_objects.rst | 29 +++++++++++++++++++ doc/source/api/diffpy.utils.wx.rst | 8 +++-- 4 files changed, 58 insertions(+), 12 deletions(-) create mode 100644 doc/source/api/diffpy.utils.scattering_objects.rst diff --git a/doc/source/api/diffpy.utils.parsers.rst b/doc/source/api/diffpy.utils.parsers.rst index 82c70ed7..223accd7 100644 --- a/doc/source/api/diffpy.utils.parsers.rst +++ b/doc/source/api/diffpy.utils.parsers.rst @@ -1,4 +1,4 @@ -.. _Parsers Documentation: +:tocdepth: -1 diffpy.utils.parsers package ============================ @@ -8,28 +8,38 @@ diffpy.utils.parsers package :undoc-members: :show-inheritance: -For a sample data extraction workflow, see :ref:`parsers example`. +Submodules +---------- + +diffpy.utils.parsers.resample module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.utils.parsers.resample + :members: + :undoc-members: + :show-inheritance: diffpy.utils.parsers.loaddata module ------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.utils.parsers.loaddata :members: :undoc-members: :show-inheritance: -diffpy.utils.parsers.serialization module ------------------------------------------ +diffpy.utils.parsers.custom_exceptions module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.utils.parsers.serialization +.. automodule:: diffpy.utils.parsers.custom_exceptions :members: :undoc-members: :show-inheritance: -diffpy.utils.parsers.resample module ------------------------------------- +diffpy.utils.parsers.serialization module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.utils.parsers.resample +.. automodule:: diffpy.utils.parsers.serialization :members: :undoc-members: :show-inheritance: + diff --git a/doc/source/api/diffpy.utils.rst b/doc/source/api/diffpy.utils.rst index f9a9c099..3ce300f4 100644 --- a/doc/source/api/diffpy.utils.rst +++ b/doc/source/api/diffpy.utils.rst @@ -12,17 +12,20 @@ Subpackages ----------- .. toctree:: + :titlesonly: diffpy.utils.parsers diffpy.utils.wx + diffpy.utils.scattering_objects Submodules ---------- diffpy.utils.tools module -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.utils.tools :members: :undoc-members: :show-inheritance: + diff --git a/doc/source/api/diffpy.utils.scattering_objects.rst b/doc/source/api/diffpy.utils.scattering_objects.rst new file mode 100644 index 00000000..928eca4a --- /dev/null +++ b/doc/source/api/diffpy.utils.scattering_objects.rst @@ -0,0 +1,29 @@ +:tocdepth: -1 + +diffpy.utils.scattering_objects package +======================================= + +.. automodule:: diffpy.utils.scattering_objects + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +diffpy.utils.scattering_objects.user_config module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.utils.scattering_objects.user_config + :members: + :undoc-members: + :show-inheritance: + +diffpy.utils.scattering_objects.diffraction_objects module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.utils.scattering_objects.diffraction_objects + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api/diffpy.utils.wx.rst b/doc/source/api/diffpy.utils.wx.rst index fb747f58..60f60599 100644 --- a/doc/source/api/diffpy.utils.wx.rst +++ b/doc/source/api/diffpy.utils.wx.rst @@ -1,4 +1,4 @@ -.. _wx Python Utilities Documentation +:tocdepth: -1 diffpy.utils.wx package ======================= @@ -8,10 +8,14 @@ diffpy.utils.wx package :undoc-members: :show-inheritance: +Submodules +---------- + diffpy.utils.wx.gridutils module --------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.utils.wx.gridutils :members: :undoc-members: :show-inheritance: + From c115f18c827b35ef9526fbeb5f8cd0bfed122869 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 16 Sep 2024 19:33:38 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit hooks --- doc/source/api/diffpy.utils.parsers.rst | 1 - doc/source/api/diffpy.utils.rst | 1 - doc/source/api/diffpy.utils.scattering_objects.rst | 1 - doc/source/api/diffpy.utils.wx.rst | 1 - 4 files changed, 4 deletions(-) diff --git a/doc/source/api/diffpy.utils.parsers.rst b/doc/source/api/diffpy.utils.parsers.rst index 223accd7..0709cf3a 100644 --- a/doc/source/api/diffpy.utils.parsers.rst +++ b/doc/source/api/diffpy.utils.parsers.rst @@ -42,4 +42,3 @@ diffpy.utils.parsers.serialization module :members: :undoc-members: :show-inheritance: - diff --git a/doc/source/api/diffpy.utils.rst b/doc/source/api/diffpy.utils.rst index 3ce300f4..cf69f596 100644 --- a/doc/source/api/diffpy.utils.rst +++ b/doc/source/api/diffpy.utils.rst @@ -28,4 +28,3 @@ diffpy.utils.tools module :members: :undoc-members: :show-inheritance: - diff --git a/doc/source/api/diffpy.utils.scattering_objects.rst b/doc/source/api/diffpy.utils.scattering_objects.rst index 928eca4a..fe511bf5 100644 --- a/doc/source/api/diffpy.utils.scattering_objects.rst +++ b/doc/source/api/diffpy.utils.scattering_objects.rst @@ -26,4 +26,3 @@ diffpy.utils.scattering_objects.diffraction_objects module :members: :undoc-members: :show-inheritance: - diff --git a/doc/source/api/diffpy.utils.wx.rst b/doc/source/api/diffpy.utils.wx.rst index 60f60599..76c89035 100644 --- a/doc/source/api/diffpy.utils.wx.rst +++ b/doc/source/api/diffpy.utils.wx.rst @@ -18,4 +18,3 @@ diffpy.utils.wx.gridutils module :members: :undoc-members: :show-inheritance: -