Testing

Flake8

RetroArcher uses Flake8 for enforcing consistent code styling. Flake is included in the requirements-dev.txt.

The config file for flake8 is .flake8. This is already included in the root of the repo and should not be modified.

Test with Flake8
python -m flake8

Sphinx

RetroArcher uses Sphinx for documentation building. Sphinx is included in the standard requirements.txt as building the docs is required for RetroArcher to be fully functional.

RetroArcher follows numpydoc styling and formatting in docstrings. This will be tested when building the docs.

The config file for Sphinx is docs/source/conf.py. This is already included in the root of the repo and should not be modified.

Test with Sphinx
cd docs
make html

Alternatively

cd docs
sphinx-build -b html source build

pytest

RetroArcher uses pytest for unit testing. pytest is included in the requirements-dev.txt.

No config is required for pytest.

Prior to running pytest you will need to:

Test with pytest
python -m pytest