$ 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
make test lintin the project root. This will run
nosetestswith coverage and also display any
$ make test lint
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 PyDocX 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
All python source files must be PEP8 compliant.
All python source files must include the following import declaration at the top of the file:
from __future__ import ( absolute_import, print_function, unicode_literals, )
- All stream data is assumed to be a UTF-8 bytestream unless specified otherwise. What this means is that when you are writing test cases for a particular function, any input data you define which would have otherwise have come from a file source must be encoded as UTF-8.