Add requirements-docs.txt and update development docs accordingly

This commit is contained in:
Stein Magnus Jodal 2010-02-21 15:24:49 +01:00
parent 45af7ef21e
commit cafab89f84
3 changed files with 23 additions and 2 deletions

View File

@ -67,16 +67,35 @@ Debian/Ubuntu package management::
sudo aptitude install python-coverage
The rest can be installed using pip::
The rest (or all dependencies if you want to) can be installed using pip::
sudo aptitude install python-pip python-setuptools bzr
sudo pip install -r test-requirements.txt
sudo pip install -r requirements-tests.txt
Then, to run all tests::
python tests
Generating documentation
========================
To generate documentation, you also need some additional dependencies. You can either install them through Debian/Ubuntu package management::
sudo aptitude install python-sphinx
Or, install them using pip::
sudo aptitude install python-pip python-setuptools
sudo pip install -r requirements-docs.txt
Then, to generate docs::
cd docs/
make # For help on available targets
make html # To generate HTML docs
Music Player Daemon (MPD)
=========================

1
requirements-docs.txt Normal file
View File

@ -0,0 +1 @@
Sphinx

View File

@ -1 +1,2 @@
coverage
-e bzr+http://liw.iki.fi/bzr/coverage-test-runner/trunk/#egg=CoverageTestRunner