Open
Description
Our API docs currently live in two places:
-
in the source itself, as:
#some_file.py def some_func(...): """ The API docs """
for example,
Lines 366 to 374 in 3883eca
-
in
module-components.rst
, as:.. function:: some_func(...) :no-index: The other API docs
for example,
galgebra/doc/module-components.rst
Lines 112 to 122 in 3883eca
We should merge these together, by:
- Manually merging the docstrings to preserve the best parts of each
- Removing the contents of the
.. function::
directive inmodule-components.rst
, and changing it to.. autofunction:: some_file.some_func :no-index:
See #301 for an example of the type of change we should be fixing this with.