This patch applies a framework update adding automatic documentation generation.
The documentation of functions and methods must follow the numpy style. For examples, you might refer to framework/setup.py. Github Flavored Markdown (GFM) is supported.
Note that you must also update your framewok locally, e.g as:
pip3.7 install --user --upgrade git+https://github.com/grand-mother/framework.git@master
cd /path/to/radio-simus # If not already there
grand-pkg-init
Once merged
This update should add a new docs badge to the README. Clicking on the badge redirects to an error report. The generated documentation can be browsed from the GRAND/packages web page, by clicking on your package name.
This patch applies a framework update adding automatic documentation generation.
The documentation of functions and methods must follow the numpy style. For examples, you might refer to framework/setup.py. Github Flavored Markdown (GFM) is supported.
Note that you must also update your framewok locally, e.g as:
Once merged
This update should add a new
docsbadge to the README. Clicking on the badge redirects to an error report. The generated documentation can be browsed from the GRAND/packages web page, by clicking on your package name.