Skip to content

Commit b4eb81c

Browse files
author
Alexander Lisianoi
committed
Add documentation about testing boolean.py with tox
Signed-off-by: Aleksandr Lisianoi <[email protected]>
1 parent c8ae4e4 commit b4eb81c

File tree

2 files changed

+42
-3
lines changed

2 files changed

+42
-3
lines changed

README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,30 @@ Documentation
3838

3939
http://readthedocs.org/docs/booleanpy/en/latest/
4040

41+
Installation
42+
------------
4143

44+
`pip install boolean.py`
4245

43-
Download and installation
44-
-------------------------
46+
Testing
47+
-------
48+
49+
Test `boolean.py` with your current Python environment:
50+
51+
`python setup.py test`
4552

46-
`pip install boolean.py`
53+
Test with all of the supported Python environments using `tox`:
4754

55+
```
56+
pip install -r test-requirements.txt
57+
tox
58+
```
59+
60+
If `tox` throws `InterpreterNotFound`, limit it to python interpreters that are actually installed on your machine:
61+
62+
```
63+
tox -e py27,py36
64+
```
4865

4966
License
5067
-------

docs/development_guide.rst

+22
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,28 @@ and laws are stated in :doc:`concepts`.
1010
:depth: 2
1111
:backlinks: top
1212

13+
Testing
14+
-------
15+
16+
Test `boolean.py` with your current Python environment:
17+
18+
.. code-block:: shell
19+
20+
python setup.py test
21+
22+
Test with all of the supported Python environments using `tox`:
23+
24+
.. code-block:: shell
25+
26+
pip install -r test-requirements.txt
27+
tox
28+
29+
If `tox` throws `InterpreterNotFound`, limit it to python interpreters that are actually installed on your machine:
30+
31+
.. code-block:: shell
32+
33+
tox -e py27,py36
34+
1335
Classes Hierarchy
1436
-----------------
1537
..

0 commit comments

Comments
 (0)