Skip to content

Add new api-documentation #228

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.

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 3 commits into from
Jul 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:tocdepth: -1

diffpy.morph.morph_helpers package
diffpy.morph.morp_helpers package
==================================

.. automodule:: diffpy.morph.morph_helpers
Expand All @@ -11,18 +11,18 @@ diffpy.morph.morph_helpers package
Submodules
----------

diffpy.morph.morph_helpers.transformpdftordf module
diffpy.morph.morph_helpers.transformrdftopdf module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morph_helpers.transformpdftordf
.. automodule:: diffpy.morph.morph_helpers.transformrdftopdf
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morph_helpers.transformrdftopdf module
diffpy.morph.morph_helpers.transformpdftordf module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morph_helpers.transformrdftopdf
.. automodule:: diffpy.morph.morph_helpers.transformpdftordf
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -11,42 +11,58 @@ diffpy.morph.morphs package
Submodules
----------

diffpy.morph.morphs.morphishape module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.morphs.morphscale module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphishape
.. automodule:: diffpy.morph.morphs.morphscale
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphchain module
diffpy.morph.morphs.morphshape module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphchain
.. automodule:: diffpy.morph.morphs.morphshape
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphresolution module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.morphs.morphshift module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphresolution
.. automodule:: diffpy.morph.morphs.morphshift
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphshape module
diffpy.morph.morphs.morphfuncy module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphshape
.. automodule:: diffpy.morph.morphs.morphfuncy
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphshift module
diffpy.morph.morphs.morphchain module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphshift
.. automodule:: diffpy.morph.morphs.morphchain
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphresolution module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphresolution
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphstretch module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphstretch
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -59,34 +75,34 @@ diffpy.morph.morphs.morph module
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphrgrid module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.morphs.morphsqueeze module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphrgrid
.. automodule:: diffpy.morph.morphs.morphsqueeze
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphsmear module
diffpy.morph.morphs.morphrgrid module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphsmear
.. automodule:: diffpy.morph.morphs.morphrgrid
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphstretch module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.morphs.morphishape module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphstretch
.. automodule:: diffpy.morph.morphs.morphishape
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.morphs.morphscale module
diffpy.morph.morphs.morphsmear module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.morphs.morphscale
.. automodule:: diffpy.morph.morphs.morphsmear
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Subpackages
.. toctree::
:titlesonly:

diffpy.morph.morphs
diffpy.morph.morph_helpers
diffpy.morph.morphs

Submodules
----------
Expand All @@ -36,18 +36,18 @@ diffpy.morph.morph_api module
:undoc-members:
:show-inheritance:

diffpy.morph.refine module
^^^^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.tools module
^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.refine
.. automodule:: diffpy.morph.tools
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.tools module
^^^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.morphpy module
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.tools
.. automodule:: diffpy.morph.morphpy
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -60,10 +60,10 @@ diffpy.morph.morph_io module
:undoc-members:
:show-inheritance:

diffpy.morph.log module
^^^^^^^^^^^^^^^^^^^^^^^
diffpy.morph.refine module
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.log
.. automodule:: diffpy.morph.refine
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -75,3 +75,11 @@ diffpy.morph.morphapp module
:members:
:undoc-members:
:show-inheritance:

diffpy.morph.log module
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.morph.log
:members:
:undoc-members:
:show-inheritance:
3 changes: 2 additions & 1 deletion doc/source/conf.py → docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
except Exception:
fullversion = "No version found. The correct version will appear in the released version." # noqa: E501

# Import modules referenced in documentation (resolves `WARNING: autodoc: failed to import module`)
# Import modules referenced in documentation
# (resolves `WARNING: autodoc: failed to import module`)
autodoc_mock_imports = [
"diffpy.utils",
]
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading