How to contribute

The LSTOSA code and docs reside on this this GitHub repository. If you want to contribute or have any question on how to use it ask its developers. You can also use GitHub Issues to ask or report any problem you may find.

If you know nothing about git, we recommend to follow this guide.

How to build the docs

You can find these docs in the docs folder inside the repository. They are build via the Sphinx package, deployed and published using Read The Docs.

To build the docs locally on your machine, you need to activate the osa-dev environment first. This conda environment can be created using the environment.yml file from the repository containing packages needed to generate the documentation:

• sphinx

• numpydoc

• sphinx_rtd_theme

• sphinx-argparse

• sphinx-automodapi

Once the environment is activated just run following command inside the docs folder:

make clean html

Python Docstrings

For the docstrings in the python code we use the NumPy Style. These docstrings are then interpreted by Sphinx and used to build the API references in the LSTOSA code section.