Skip to content

api workflow build for diffpy.srmise #102

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 2 commits into from
Aug 26, 2024
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
28 changes: 28 additions & 0 deletions doc/source/api/diffpy.srmise.applications.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
:tocdepth: -1

diffpy.srmise.applications package
==================================

.. automodule:: diffpy.srmise.applications
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

diffpy.srmise.applications.plot module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.applications.plot
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.applications.extract module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.applications.extract
:members:
:undoc-members:
:show-inheritance:
52 changes: 52 additions & 0 deletions doc/source/api/diffpy.srmise.baselines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
:tocdepth: -1

diffpy.srmise.baselines package
===============================

.. automodule:: diffpy.srmise.baselines
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

diffpy.srmise.baselines.nanospherical module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.baselines.nanospherical
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.baselines.arbitrary module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.baselines.arbitrary
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.baselines.fromsequence module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.baselines.fromsequence
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.baselines.polynomial module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.baselines.polynomial
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.baselines.base module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.baselines.base
:members:
:undoc-members:
:show-inheritance:
31 changes: 0 additions & 31 deletions doc/source/api/diffpy.srmise.example_package.rst

This file was deleted.

36 changes: 36 additions & 0 deletions doc/source/api/diffpy.srmise.modelevaluators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
:tocdepth: -1

diffpy.srmise.modelevaluators package
=====================================

.. automodule:: diffpy.srmise.modelevaluators
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

diffpy.srmise.modelevaluators.aic module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.modelevaluators.aic
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.modelevaluators.aicc module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.modelevaluators.aicc
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.modelevaluators.base module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.modelevaluators.base
:members:
:undoc-members:
:show-inheritance:
44 changes: 44 additions & 0 deletions doc/source/api/diffpy.srmise.peaks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
:tocdepth: -1

diffpy.srmise.peaks package
===========================

.. automodule:: diffpy.srmise.peaks
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

diffpy.srmise.peaks.gaussianoverr module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.peaks.gaussianoverr
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.peaks.terminationripples module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.peaks.terminationripples
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.peaks.base module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.peaks.base
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.peaks.gaussian module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.peaks.gaussian
:members:
:undoc-members:
:show-inheritance:
99 changes: 90 additions & 9 deletions doc/source/api/diffpy.srmise.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
:tocdepth: -1

|title|
=======

.. |title| replace:: diffpy.srmise package
diffpy.srmise package
=====================

.. automodule:: diffpy.srmise
:members:
Expand All @@ -14,17 +12,100 @@ Subpackages
-----------

.. toctree::
diffpy.srmise.example_package
:titlesonly:

diffpy.srmise.peaks
diffpy.srmise.modelevaluators
diffpy.srmise.applications
diffpy.srmise.baselines

Submodules
----------

|module|
--------
diffpy.srmise.multimodelselection module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.multimodelselection
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.srmiselog module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.srmiselog
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.modelparts module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.modelparts
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.peakstability module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.peakstability
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.basefunction module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.basefunction
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.pdfpeakextraction module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.pdfpeakextraction
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.modelcluster module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.modelcluster
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.dataclusters module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.dataclusters
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.srmiseerrors module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.srmiseerrors
:members:
:undoc-members:
:show-inheritance:

diffpy.srmise.peakextraction module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.peakextraction
:members:
:undoc-members:
:show-inheritance:

.. |module| replace:: diffpy.srmise.example_submodule module
diffpy.srmise.pdfdataset module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.srmise.example_submodule
.. automodule:: diffpy.srmise.pdfdataset
:members:
:undoc-members:
:show-inheritance:
Loading