Skip to content

Commit 6b193e2

Browse files
authored
Auto-generate framework for Python API reference documentation (#1565)
Part of #1439 . I added the public functions (the one that doesn't start with a "_") to the documentation. Give some short description on some of them.
1 parent 63dad9a commit 6b193e2

File tree

2 files changed

+8
-27
lines changed

2 files changed

+8
-27
lines changed

docs/_quarto.yml

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -108,30 +108,9 @@ quartodoc:
108108
dir: reference/python
109109
title: Python API
110110
package: ribasim
111-
sections:
112-
- title: Model
113-
desc: The Model class represents an entire Ribasim model.
114-
contents:
115-
- Model
116-
- title: Edge
117-
desc: The Edge database layer.
118-
contents:
119-
- EdgeTable
120-
- title: Node types
121-
desc: Available node types to model different situations.
122-
contents:
123-
- nodes.basin
124-
- nodes.fractional_flow
125-
- nodes.tabulated_rating_curve
126-
- nodes.pump
127-
- nodes.outlet
128-
- nodes.user_demand
129-
- nodes.level_boundary
130-
- nodes.flow_boundary
131-
- nodes.linear_resistance
132-
- nodes.manning_resistance
133-
- nodes.terminal
134-
- nodes.discrete_control
135-
- nodes.pid_control
136-
- nodes.flow_demand
137-
- nodes.level_demand
111+
options:
112+
include_inherited: true
113+
include_empty: true
114+
include_attributes: true
115+
include_classes: true
116+
include_functions: true

python/ribasim/ribasim/model.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@
6262

6363

6464
class Model(FileModel):
65+
"""A model of inland water resources systems."""
66+
6567
starttime: datetime.datetime
6668
endtime: datetime.datetime
6769
crs: str

0 commit comments

Comments
 (0)