Documenting NansatΒΆ
Documentation should follow the conventions.
Note
Documentation for classes should be given after the class definition, not within the
__init__
-method.
To build documentation locally, the best is to create a virtual environment with the sphinx environment installed. This is done as follows:
cd docs
conda env create -n build_docs --file environment.yml
source activate build_docs
Then, the following commands should build the documentation:
make clean
sphinx-apidoc -fo source/ ../nansat
make html
Some documentation remains to be written. This is marked by TODO
in the rst source files. Find
open tasks by:
cd docs/source
grep TODO *