You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Mar 24, 2021. It is now read-only.
Anna Nelles edited this page May 8, 2019
·
6 revisions
How to document the software
All parts of the software are documented in the source code using python docstrings. Human-Readable documentation can then be generated using Sphinx. We use the numpy docstring syntax (https://numpydoc.readthedocs.io/en/latest/format.html).
how to generate the documentation
just execute make html in the autodoc folder. Please note that the folder that contains NuRadioReco needs to be in you PYTHONPATH environment variable. The generated documentation is then available in _autodoc/build/html/index.html.