@@ -3,11 +3,6 @@ Development
33
44.. highlight :: bash
55
6- This package is developed using continuous integration which can be
7- found here:
8-
9- https://travis-ci.org/python-excel/xlrd
10-
116If you wish to contribute to this project, then you should fork the
127repository found here:
138
@@ -24,40 +19,34 @@ your checkout into a virtualenv and then install the package in
2419editable form as follows::
2520
2621 $ virtualenv .
27- $ bin/pip install -e .
22+ $ bin/pip install -e .[test]
2823
2924Running the tests
3025-----------------
3126
3227Once you've set up a virtualenv, the tests can be run as follows::
3328
34- $ python -m unittest discover
35-
36- To run tests on all the versions of Python that are supported, you can do::
37-
38- $ bin/tox
39-
40- If you change the supported python versions in ``.travis.yml ``, please remember
41- to do the following to update ``tox.ini ``::
42-
43- $ bin/panci --to=tox .travis.yml > tox.ini
29+ $ source bin/activate
30+ $ pytest
4431
4532Building the documentation
4633--------------------------
4734
4835The Sphinx documentation is built by doing the following, having activated
4936the virtualenv above, from the directory containing setup.py::
5037
38+ $ source bin/activate
5139 $ cd docs
5240 $ make html
5341
42+ To check that the description that will be used on PyPI renders properly,
43+ do the following::
44+
45+ $ python setup.py --long-description | rst2html.py > desc.html
46+
5447Making a release
5548----------------
5649
57- To make a release, just update the version in ``xlrd.info.__VERSION__ ``,
58- update the change log, tag it, push to https://github.com/python-excel/xlrd
59- and Travis CI should take care of the rest.
60-
61- Once the above is done, make sure to go to
62- https://readthedocs.org/projects/xlrd/versions/
63- and make sure the new release is marked as an Active Version.
50+ To make a release, just update the version in ``xlrd.info.__VERSION__ ``, update the change log
51+ and push to https://github.com/python-excel/xlrd
52+ and Carthorse should take care of the rest.
0 commit comments