diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 823f26daf..3c81afb1c 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -8,5 +8,6 @@ components. :maxdepth: 2 cli - operators recipe-format + operators + internal diff --git a/docs/source/reference/internal.rst b/docs/source/reference/internal.rst new file mode 100644 index 000000000..da0762548 --- /dev/null +++ b/docs/source/reference/internal.rst @@ -0,0 +1,36 @@ +Internal Functions +================== + +This page details various internal functions within CSET. Most people should +never have to worry about these, but they are documented here for the +convenience of those developing CSET. + +CSET.operators +-------------- + +.. automodule:: CSET.operators + :members: + +CSET.recipes +------------ + +.. automodule:: CSET.recipes + :members: + +CSET.graph +---------- + +.. automodule:: CSET.graph + :members: + +CSET._common +------------ + +.. note:: + + While no functions documented on this page are part of any API promise, the + functions inside _common are especially liable to change without any kind of + notice. + +.. automodule:: CSET._common + :members: diff --git a/docs/source/reference/operators.rst b/docs/source/reference/operators.rst index fd1b635cd..34714d146 100644 --- a/docs/source/reference/operators.rst +++ b/docs/source/reference/operators.rst @@ -5,6 +5,12 @@ This page details the operators contained within CSET. It is automatically generated from the code and its docstrings. Operators should be used via :doc:`/usage/operator-recipes`. +CSET.operators.collapse +----------------------- + +.. automodule:: CSET.operators.collapse + :members: + CSET.operators.constraints -------------------------- diff --git a/src/CSET/operators/misc.py b/src/CSET/operators/misc.py index bde4f960a..4f6d30837 100644 --- a/src/CSET/operators/misc.py +++ b/src/CSET/operators/misc.py @@ -27,11 +27,10 @@ def noop(x, **kwargs): x: Any Input to return. - Will silently accept any additional keyword arguments for testing purposes. - Returns ------- x: Any The input that was given. """ + return x