Reference document for contributors. Here we document part of the private API of the library as well as the suite of developer commands and scripts configured and included in the repository.
tox to automatically handle
testing (locally and on GitHub actions),
building documentation locally,
formatting and linting.
Here are the tox commands available which should be executed as
tox -e <command>
Modifies the files using black and isort so they comply with formatting requirements.
Runs black, isort, pylint and pydocstyle to check both code style, presence of documentation everywhere that follows numpydoc convention and catching some code errors and bad practices.
sphinx-build to generate the documentation.
Deletes all doc cache and intermediate files to rebuild the docs from
scratch the next time you use the
gnome-open to open the documentation build by tox. Opens the homepage
Runs test suite with pytest
Register methods to XrRV classes and document them from a template.
Base random variable wrapper class.
Help wrap functions with a single input that return an output with the same size.
Help wrap functions with a single input that return an output after reducing some dimensions.
Tutorial module with data for docs and quick testing.