Add refstate API reference

amorison · amorison · commit 90639b17b5a6 · 2020-06-09T00:07:27.000+02:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -48,6 +48,7 @@ Welcome to StagPy's documentation!
    sources/apiref/phyvars
    sources/apiref/plates
    sources/apiref/processing
+   sources/apiref/refstate
    sources/apiref/rprof
    sources/apiref/stagyydata
    sources/apiref/step
diff --git a/docs/sources/apiref/refstate.rst b/docs/sources/apiref/refstate.rst
@@ -0,0 +1,5 @@
+refstate
+========
+
+.. automodule:: stagpy.refstate
+   :members:
diff --git a/docs/sources/tuto.rst b/docs/sources/tuto.rst
@@ -21,6 +21,7 @@ This means a minimal call to StagPy is as follow::
 ``<subcommand>`` can be one of the following:
 
 * ``field``: plot scalar fields such as temperature or stream function;
+* ``refstate``: plot reference state;
 * ``rprof``: plot radial profiles;
 * ``time``: plot time series;
 * ``plates``: perform plate analysis;
