From cafab89f84e61d43b91c7223945b590d2b382e8e Mon Sep 17 00:00:00 2001
From: Stein Magnus Jodal <stein.magnus@jodal.no>
Date: Sun, 21 Feb 2010 15:24:49 +0100
Subject: [PATCH] Add requirements-docs.txt and update development docs
 accordingly

---
 docs/development.rst                          | 23 +++++++++++++++++--
 requirements-docs.txt                         |  1 +
 ...requirements.txt => requirements-tests.txt |  1 +
 3 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 requirements-docs.txt
 rename test-requirements.txt => requirements-tests.txt (89%)

diff --git a/docs/development.rst b/docs/development.rst
index 826dd215..116442e6 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -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)
 =========================
 
diff --git a/requirements-docs.txt b/requirements-docs.txt
new file mode 100644
index 00000000..2806c164
--- /dev/null
+++ b/requirements-docs.txt
@@ -0,0 +1 @@
+Sphinx
diff --git a/test-requirements.txt b/requirements-tests.txt
similarity index 89%
rename from test-requirements.txt
rename to requirements-tests.txt
index 459f434a..0342fb1c 100644
--- a/test-requirements.txt
+++ b/requirements-tests.txt
@@ -1 +1,2 @@
+coverage
 -e bzr+http://liw.iki.fi/bzr/coverage-test-runner/trunk/#egg=CoverageTestRunner