Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
keurfonluu committed Aug 8, 2023
1 parent c43fc24 commit e987c44
Showing 4 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -7,6 +7,7 @@ API Reference

io
mesh
run
rpcap
cli

6 changes: 4 additions & 2 deletions doc/source/api/io.rst
Original file line number Diff line number Diff line change
@@ -14,10 +14,12 @@ Input parameters
Simulation outputs
------------------

.. autofunction:: toughio.read_history

.. autofunction:: toughio.read_output

.. autofunction:: toughio.read_table

.. autofunction:: toughio.write_h5

.. autofunction:: toughio.write_output

.. autofunction:: toughio.register_output
4 changes: 4 additions & 0 deletions doc/source/api/run.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Run
===

.. autofunction:: toughio.run
1 change: 1 addition & 0 deletions toughio/_io/h5/_write.py
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@ def write(
filename : str or pathlike
Output file name.
elements : namedtuple, list of namedtuple, str, pathlike or None, optional, default None
Element outputs to export.
connections : namedtuple, list of namedtuple, str, pathlike or None, optional, default None
Connection outputs to export.
element_history : dict or None, optional, default None

0 comments on commit e987c44

Please sign in to comment.