Skip to content

Commit

Permalink
Added classes to the doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
IKCAP committed Jul 26, 2024
1 parent 8012630 commit 389e56a
Showing 1 changed file with 125 additions and 0 deletions.
125 changes: 125 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,128 @@ LiPDSeries (pylipd.lipd_series.LiPDSeries)

.. autoclass:: pylipd.lipd_series.LiPDSeries
:members:

LiPD Classes
"""""""""""""

.. autoclass:: pylipd.classes.dataset.Dataset
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleodata.PaleoData
:members:
:undoc-members:

.. autoclass:: pylipd.classes.chrondata.ChronData
:members:
:undoc-members:

.. autoclass:: pylipd.classes.datatable.DataTable
:members:
:undoc-members:

.. autoclass:: pylipd.classes.variable.Variable
:members:
:undoc-members:

.. autoclass:: pylipd.classes.calibration.Calibration
:members:
:undoc-members:

.. autoclass:: pylipd.classes.uncertainty.Uncertainty
:members:
:undoc-members:

.. autoclass:: pylipd.classes.interpretation.Interpretation
:members:
:undoc-members:

.. autoclass:: pylipd.classes.changelog.ChangeLog
:members:
:undoc-members:

.. autoclass:: pylipd.classes.funding.Funding
:members:
:undoc-members:

.. autoclass:: pylipd.classes.location.Location
:members:
:undoc-members:

.. autoclass:: pylipd.classes.model.Model
:members:
:undoc-members:

.. autoclass:: pylipd.classes.publication.Publication
:members:
:undoc-members:

.. autoclass:: pylipd.classes.resolution.Resolution
:members:
:undoc-members:

.. autoclass:: pylipd.classes.physicalsample.PhysicalSample
:members:
:undoc-members:

.. autoclass:: pylipd.classes.publication.Person
:members:
:undoc-members:

LiPD Controlled Vocabulary
"""""""""""""""""""""""""""
.. autoclass:: pylipd.classes.archivetype.ArchiveType
:members:
:undoc-members:

.. autoclass:: pylipd.classes.archivetype.ArchiveTypeConstants
:members:
:undoc-members:

.. autoclass:: pylipd.classes.archivetype.PaleoUnit
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleounit.PaleoUnitConstants
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleoproxy.PaleoProxy
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleoproxy.PaleoProxyConstants
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleoproxygeneral.PaleoProxyGeneral
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleoproxygeneral.PaleoProxyGeneralConstants
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleovariable.PaleoVariable
:members:
:undoc-members:

.. autoclass:: pylipd.classes.paleovariable.PaleoVariableConstants
:members:
:undoc-members:

.. autoclass:: pylipd.classes.interpretationvariable.InterpretationVariable
:members:
:undoc-members:

.. autoclass:: pylipd.classes.interpretationvariable.InterpretationVariableConstants
:members:
:undoc-members:

.. autoclass:: pylipd.classes.interpretationseasonality.InterpretationSeasonality
:members:
:undoc-members:

.. autoclass:: pylipd.classes.interpretationseasonality.InterpretationSeasonalityConstants
:members:
:undoc-members:

0 comments on commit 389e56a

Please sign in to comment.