Skip to content

Commit 1eabcde

Browse files
authored
Merge pull request #9 from pathsim/cleanup-docs
adding tritium module to api reference in docs
2 parents fa60f65 + c9598ec commit 1eabcde

6 files changed

Lines changed: 31 additions & 6 deletions

File tree

.DS_Store

0 Bytes
Binary file not shown.

docs/.DS_Store

6 KB
Binary file not shown.

docs/source/.DS_Store

6 KB
Binary file not shown.

docs/source/api.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
API Reference
22
=============
33

4-
This page provides the API reference for PathSim-Chem modules and functions.
4+
The following modules form the chemical engineering toolbox for PathSim.
55

6-
For the core PathSim API, see the `PathSim API Reference <https://pathsim.readthedocs.io/en/latest/api.html>`_.
6+
.. grid:: 2
7+
:gutter: 3
78

8-
.. autosummary::
9-
:toctree: _autosummary
10-
:recursive:
9+
.. grid-item-card:: Tritium
10+
:link: modules/tritium
11+
:link-type: doc
1112

12-
pathsim_chem
13+
Tritium science toolbox for nuclear fusion
14+
15+
16+
.. toctree::
17+
:hidden:
18+
:maxdepth: 3
19+
20+
modules/tritium

docs/source/modules/.DS_Store

6 KB
Binary file not shown.

docs/source/modules/tritium.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
tritium
2+
=======
3+
4+
.. automodule:: pathsim_chem.tritium.splitter
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:
8+
9+
.. automodule:: pathsim_chem.tritium.residencetime
10+
:members:
11+
:show-inheritance:
12+
:undoc-members:
13+
14+
.. automodule:: pathsim_chem.tritium.bubbler
15+
:members:
16+
:show-inheritance:
17+
:undoc-members:

0 commit comments

Comments
 (0)