Skip to content

Commit

Permalink
Add documentation pages for Cigre207
Browse files Browse the repository at this point in the history
  • Loading branch information
Halvor Lund committed Jun 3, 2024
1 parent 4dace77 commit 837eb59
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/api/equations/cigre207/convective_cooling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Convective cooling in CIGRE207
------------------------------

.. automodule:: linerate.equations.cigre207.convective_cooling
:members:
5 changes: 5 additions & 0 deletions docs/api/equations/cigre207/solar_heating.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Solar heating in CIGRE207
-------------------------

.. automodule:: linerate.equations.cigre207.solar_heating
:members:
5 changes: 5 additions & 0 deletions docs/api/equations/convective_cooling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Convective cooling
------------------

.. automodule:: linerate.equations.convective_cooling
:members:
5 changes: 5 additions & 0 deletions docs/api/equations/dimensionless.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Dimensionless numbers
---------------------

.. automodule:: linerate.equations.dimensionless
:members:
14 changes: 14 additions & 0 deletions docs/api/equations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,23 @@ Shared functionality
:maxdepth: 1

joule_heating
convective_cooling
radiative_cooling
solar_angles
solar_heating
math
dimensionless

Cigre 207
^^^^^^^^^

.. automodule:: linerate.equations.cigre207

.. toctree::
:maxdepth: 1

cigre207/convective_cooling
cigre207/solar_heating

Cigre 601
^^^^^^^^^
Expand Down
5 changes: 5 additions & 0 deletions docs/api/equations/solar_heating.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Solar heating
-------------

.. automodule:: linerate.equations.solar_heating
:members:
6 changes: 6 additions & 0 deletions docs/api/model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,9 @@ The ``model`` module

.. autoclass:: linerate.model.Cigre601
:inherited-members:

.. autoclass:: linerate.model.IEEE738
:inherited-members:

.. autoclass:: linerate.model.Cigre207
:inherited-members:

0 comments on commit 837eb59

Please sign in to comment.