Before contributing to Read the Docs, make sure your patch passes our test suite and your code style passes our code linting suite.
Read the Docs uses Tox to execute testing and linting procedures. Tox is the only dependency you need to run linting or our test suite, the remainder of our requirements will be installed by Tox into environment specific virtualenv paths. Before testing, make sure you have Tox installed:
pip install tox
To run the full test and lint suite against your changes, simply run Tox. Tox should return without any errors. You can run Tox against all of our environments by running:
In order to run all test including the search tests, include
Running tests for search needs an Elasticsearch instance running locally.
To target a specific environment:
tox -e py36
tox configuration has the following environments configured. You can
target a single environment to limit the test suite:
py36 Run our test suite using Python 3.6 lint Run code linting using `Prospector`_. This currently runs `pylint`_, `pyflakes`_, `pep8`_ and other linting tools. docs Test documentation compilation with Sphinx.