@@ -3,11 +3,6 @@ Development
3
3
4
4
.. highlight :: bash
5
5
6
- This package is developed using continuous integration which can be
7
- found here:
8
-
9
- https://travis-ci.org/python-excel/xlrd
10
-
11
6
If you wish to contribute to this project, then you should fork the
12
7
repository found here:
13
8
@@ -24,40 +19,34 @@ your checkout into a virtualenv and then install the package in
24
19
editable form as follows::
25
20
26
21
$ virtualenv .
27
- $ bin/pip install -e .
22
+ $ bin/pip install -e .[test]
28
23
29
24
Running the tests
30
25
-----------------
31
26
32
27
Once you've set up a virtualenv, the tests can be run as follows::
33
28
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
44
31
45
32
Building the documentation
46
33
--------------------------
47
34
48
35
The Sphinx documentation is built by doing the following, having activated
49
36
the virtualenv above, from the directory containing setup.py::
50
37
38
+ $ source bin/activate
51
39
$ cd docs
52
40
$ make html
53
41
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
+
54
47
Making a release
55
48
----------------
56
49
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