Skip to content

Commit

Permalink
DOC: Make use of autoapi to generate doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Abel Aoun committed Mar 19, 2024
1 parent cd00529 commit cc45566
Show file tree
Hide file tree
Showing 55 changed files with 19,461 additions and 19 deletions.
2,147 changes: 2,147 additions & 0 deletions doc/source/autoapi/icclim/_generated/_dcsc/index.rst

Large diffs are not rendered by default.

4,069 changes: 4,069 additions & 0 deletions doc/source/autoapi/icclim/_generated/_ecad/index.rst

Large diffs are not rendered by default.

1,469 changes: 1,469 additions & 0 deletions doc/source/autoapi/icclim/_generated/_generic/index.rst

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions doc/source/autoapi/icclim/_generated/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:py:mod:`icclim._generated`
===========================

.. py:module:: icclim._generated
Submodules
----------
.. toctree::
:titlesonly:
:maxdepth: 1

_dcsc/index.rst
_ecad/index.rst
_generic/index.rst
183 changes: 183 additions & 0 deletions doc/source/autoapi/icclim/dcsc/dcsc_indices/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
:py:mod:`icclim.dcsc.dcsc_indices`
==================================

.. py:module:: icclim.dcsc.dcsc_indices
Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

icclim.dcsc.dcsc_indices.DcscIndexRegistry




Attributes
~~~~~~~~~~

.. autoapisummary::

icclim.dcsc.dcsc_indices.DCSC_REFERENCE
icclim.dcsc.dcsc_indices.DCSC_SOURCE


.. py:data:: DCSC_REFERENCE
:value: 'Portail DRIAS, DCSC, MeteoFrance'



.. py:data:: DCSC_SOURCE
:value: 'Portail DRIAS, DCSC, MeteoFrance'



.. py:class:: DcscIndexRegistry
Bases: :py:obj:`icclim.models.registry.Registry`\ [\ :py:obj:`icclim.models.standard_index.StandardIndex`\ ]

Registry of the DCSC (Meteo France) specific indices.

.. note:: The indices metadata of this module are in French.

.. py:attribute:: _item_class
.. py:attribute:: TAV
.. py:attribute:: TXAV
.. py:attribute:: TRAV
.. py:attribute:: TX10
.. py:attribute:: TX90
.. py:attribute:: TN10
.. py:attribute:: TN90
.. py:attribute:: TNFD
.. py:attribute:: TXFD
.. py:attribute:: SD
.. py:attribute:: TX35
.. py:attribute:: TR
.. py:attribute:: TXND
.. py:attribute:: TNHT
.. py:attribute:: TNND
.. py:attribute:: TNCWD
.. py:attribute:: TXHWD
.. py:attribute:: HDD
.. py:attribute:: CDD
.. py:attribute:: PAV
.. py:attribute:: PINT
.. py:attribute:: RR
.. py:attribute:: RR1MM
.. py:attribute:: PN20MM
.. py:attribute:: PXCDD
.. py:attribute:: PXCWD
.. py:attribute:: R99
.. py:attribute:: PFL90
.. py:attribute:: PQ90
.. py:attribute:: PQ99
.. py:attribute:: FFAV
.. py:attribute:: FF98
.. py:method:: get_item_aliases(item: icclim.models.standard_index.StandardIndex) -> list[str]
:staticmethod:

Should be overridden.
Loading

0 comments on commit cc45566

Please sign in to comment.