Skip to content

Commit

Permalink
api workflow build for diffpy.srmise
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenhua0320 committed Aug 26, 2024
1 parent e47955f commit af06a74
Show file tree
Hide file tree
Showing 6 changed files with 255 additions and 40 deletions.
29 changes: 29 additions & 0 deletions doc/source/api/diffpy.srmise.applications.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
: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:

53 changes: 53 additions & 0 deletions doc/source/api/diffpy.srmise.baselines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
: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.

37 changes: 37 additions & 0 deletions doc/source/api/diffpy.srmise.modelevaluators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
: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:

45 changes: 45 additions & 0 deletions doc/source/api/diffpy.srmise.peaks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
: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:

100 changes: 91 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,101 @@ 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:

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

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

diffpy.srmise.pdfdataset module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

0 comments on commit af06a74

Please sign in to comment.