Development

Testing

Pyrobopath uses the pytest framework. The tests are found in the test/ folder. Ensure that Pyrobopath has been installed with the [dev] dependencies enabled.

In the root directory of the repository run one of the following commands.

pytest # pytest
python3 -m unittest # unittest

Building Documentation Locally

To build this documentation locally, first make sure that Pyrobopath has been installed with the [dev] dependencies enabled. The documentation is created with Sphinx.

Change directories to the doc/ folder and run the following commands to build the documentation.

make html

The built docs can be found in the _build/html folder. Double-click index.html to show the docs in your default browser.