Skip to content

Include api doc #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2024
Merged

Include api doc #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34261a1
Include api doc
bobleesj Sep 16, 2024
c115f18
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions doc/source/api/diffpy.utils.parsers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _Parsers Documentation:
:tocdepth: -1

diffpy.utils.parsers package
============================
Expand All @@ -8,28 +8,37 @@ diffpy.utils.parsers package
:undoc-members:
:show-inheritance:

For a sample data extraction workflow, see :ref:`parsers example<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:
4 changes: 3 additions & 1 deletion doc/source/api/diffpy.utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,17 @@ Subpackages
-----------

.. toctree::
:titlesonly:

diffpy.utils.parsers
diffpy.utils.wx
diffpy.utils.scattering_objects

Submodules
----------

diffpy.utils.tools module
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.utils.tools
:members:
Expand Down
28 changes: 28 additions & 0 deletions doc/source/api/diffpy.utils.scattering_objects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
: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:
7 changes: 5 additions & 2 deletions doc/source/api/diffpy.utils.wx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _wx Python Utilities Documentation
:tocdepth: -1

diffpy.utils.wx package
=======================
Expand All @@ -8,8 +8,11 @@ diffpy.utils.wx package
:undoc-members:
:show-inheritance:

Submodules
----------

diffpy.utils.wx.gridutils module
--------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.utils.wx.gridutils
:members:
Expand Down