Skip to content

Commit efe8d23

Browse files
adjust documentation for test/dev dependencies
1 parent e8c8dda commit efe8d23

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

MANIFEST.in

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
include README.rst LICENSE tox.ini .coveragerc runtests.py
22

3-
recursive-include requirements *
4-
53
recursive-include require_license *
64
prune require_license/tests/static
75
prune require_license/tests/media

doc/development.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
Development
22
===========
33

4-
After checkout, install package in active virtualenv::
4+
After checkout, install the package in an active virtualenv::
55

66
pip install -e .
77

8+
And install the required dependencies needed to run the tests::
9+
10+
pip install -r require_license/tests/requirements.txt
11+
812

913
Testing
1014
-------
@@ -17,7 +21,7 @@ Running tests without Tox_::
1721

1822
./runtests.py
1923

20-
Directly with ``django-admin``::
24+
Or directly with ``django-admin``::
2125

2226
django-admin test --settings=require_license.tests.settings require_license
2327

@@ -33,5 +37,20 @@ To generate a test coverage report using `coverage.py`_::
3337
The resulting HTML report can be found in the ``htmlcov`` directory.
3438

3539

40+
Documentation
41+
-------------
42+
43+
Install Sphinx::
44+
45+
pip install sphinx>=1.1.0
46+
47+
Change to the ``doc`` directory and run::
48+
49+
make html
50+
51+
The resulting HTML documentation can be found in the ``doc/_build/html``
52+
directory.
53+
54+
3655
.. _Tox: http://tox.testrun.org/
3756
.. _coverage.py: http://nedbatchelder.com/code/coverage/
File renamed without changes.

requirements/development.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)