Skip to content

Commit a18052b

Browse files
Birgit SchachlerBirgit Schachler
authored andcommitted
Add example to API documentation
1 parent 86dc251 commit a18052b

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

doc/example.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: example
2+
3+
.. autosummary::
4+
:toctree: temp/
5+
6+
basic_example.get_weather_data
7+
basic_example.initialise_wind_turbines
8+
basic_example.calculate_power_output
9+
basic_example.plot_or_print
10+
basic_example.run_basic_example

doc/modules.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,12 @@ Methods of the ModelChain object.
9393

9494
modelchain.ModelChain.rho_hub
9595
modelchain.ModelChain.v_wind_hub
96-
modelchain.ModelChain.turbine_power_output
96+
modelchain.ModelChain.turbine_power_output
97+
98+
99+
Example
100+
==============
101+
102+
The basic example consists of the following functions.
103+
104+
.. include:: example.rst

0 commit comments

Comments
 (0)