$ pip install -r requirements/docs.txt -r requirements/testing.txt
Building the documentation locally¶
Install the documentation requirements:
$ pip install -r requirements/docs.txt
Change directory to
$ cd docs $ make html
Load HTML documentation in a web browser of your choice:
$ firefox docs/_build/html/index.html
Install the development requirements:
$ pip install -r requirements/testing.txt
nosetestsin the project root.
To run all tests against all supported versions of python,
Running tests with tox¶
tox allows us to use
one command to
run tests against
all versions of python
that we support.
Setting up tox¶
Decide how you want to manage multiple python versions.
$ pip install tox
Now that you have
tox setup, you just need to run the command
tox from the project root directory.
The terrarium project welcomes help in any of the following ways:
- Making pull requests on github for code, tests and documentation.
- Participating on open issues and pull requests, reviewing changes
Pull Request Checklist¶
To have the best chance at an immediate merge, your pull request should have:
- A passing Travis-CI build. If it fails, check the console output for reasons why.
- New unit tests for new features or bug fixes.
- New documentation in
docsfor any new features. You do want people to know how to use your new stuff, right?