Browse Source

Merge pull request #2835 from fj/topic/update-native-installation-instructions

Use requirements.txt rather than manual installation for docs
Andy Rothfusz 11 years ago
parent
commit
e2c3860ec3
1 changed files with 6 additions and 5 deletions
  1. 6 5
      docs/README.md

+ 6 - 5
docs/README.md

@@ -41,11 +41,12 @@ its dependencies. There are two main ways to install this tool:
 
 
 ###Native Installation
 ###Native Installation
 
 
-* Install sphinx: `pip install sphinx`
-    * Mac OS X: `[sudo] pip-2.7 install sphinx`
-* Install sphinx httpdomain contrib package: `pip install sphinxcontrib-httpdomain`
-    * Mac OS X: `[sudo] pip-2.7 install sphinxcontrib-httpdomain`
-* If pip is not available you can probably install it using your favorite package manager as **python-pip**
+Install dependencies from `requirements.txt` file in your `docker/docs`
+directory:
+
+* Linux: `pip install -r docs/requirements.txt`
+
+* Mac OS X: `[sudo] pip-2.7 -r docs/requirements.txt`
 
 
 ###Alternative Installation: Docker Container
 ###Alternative Installation: Docker Container