blob: 539dfb12d03b59b4cf9e66f83029e4c88ac958f6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
================
For Developers
================
If you would like to contribute to cliff-tablib directly, these
instructions should help you get started. Patches, bug reports, and
feature requests are all welcome through the `GitHub project
<https://github.com/dreamhost/cliff-tablib>`_. Contributions in the
form of patches or pull requests are easier to integrate and will
receive priority attention.
Building Documentation
======================
The documentation for cliff-tablib is written in reStructuredText and
converted to HTML using Sphinx. The build itself is driven by make.
You will need the following packages in order to build the docs:
- Sphinx
- docutils
Once all of the tools are installed into a virtualenv using
pip, run ``make docs`` to generate the HTML version of the
documentation::
$ make docs
(cd docs && make clean html)
sphinx-build -b html -d build/doctrees source build/html
Running Sphinx v1.1.3
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 1 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
done
preparing documents... done
writing output... [100%] index
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 2 warnings.
Build finished. The HTML pages are in build/html.
The output version of the documentation ends up in
``./docs/build/html`` inside your sandbox.
Running Tests
=============
The test suite for cliff-tablib uses tox_, which must be installed
separately (``pip install tox``).
To run the tests under Python 2.7 and 3.2, run ``tox`` from the top
level directory of the git repository.
To run tests under a single version of Python, specify the appropriate
environment when running tox::
$ tox -e py27
Add new tests by modifying an existing file or creating new script in
the ``tests`` directory.
.. _tox: http://codespeak.net/tox
|
