Installation¶
Use pip:
$ pip install --extra-index-url https://test.pypi.org/simple rr_sdas
Building the documentation¶
The project documentation is generated with sphinx and can simply be build using these two commands:
$ sphinx-apidoc -fMeT -o docs/source/api rr
$ sphinx-build docs/source docs/build
The first command will generates restructured files containing API documentation for all the python modules located in scripts based on their docstring. And the second command will packages all the rst files together and build this html doc.