summaryrefslogtreecommitdiffstats
path: root/user_guide_src/README.rst
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2017-07-21 10:59:51 +0200
committerAndrey Andreev <narf@devilix.net>2017-07-21 11:01:02 +0200
commit2f473195dcf6ed83fb31f90dce5b226f3e486ff0 (patch)
tree0378d65236c5fe131d89df9cbf0a2444d724e4e4 /user_guide_src/README.rst
parent954c4aac3211c5e04270c76b9f7ac11466638bef (diff)
[ci skip] Merge pull request #5188 from ryanbriscall/update-sphinx-version-userguide-src
updates version of sphinx to 1.6.3 for easyinstall command in step 2 …
Diffstat (limited to 'user_guide_src/README.rst')
-rw-r--r--user_guide_src/README.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/user_guide_src/README.rst b/user_guide_src/README.rst
index d645adb73..b31db7cf8 100644
--- a/user_guide_src/README.rst
+++ b/user_guide_src/README.rst
@@ -13,17 +13,19 @@ output it to various formats. Pages are written in human-readable
Prerequisites
=============
-Sphinx requires Python, which is already installed if you are running OS X.
+Sphinx requires Python 2.7. If you are on OS X, then you already have Python.
You can confirm in a Terminal window by executing the ``python`` command
without any parameters. It should load up and tell you which version you have
-installed. If you're not on 2.7+, go ahead and install 2.7.2 from
-http://python.org/download/releases/2.7.2/
+installed.
+
+Note: If you're not on Python 2.7, then you must upgrade. E.g. Install 2.7.2
+from http://python.org/download/releases/2.7.2/
Installation
============
1. Install `easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install>`_
-2. ``easy_install "sphinx==1.2.3"``
+2. ``easy_install "sphinx==1.6.3"``
3. ``easy_install "sphinxcontrib-phpdomain==0.1.3.post1"``
4. Install the CI Lexer which allows PHP, HTML, CSS, and JavaScript syntax highlighting in code examples (see *cilexer/README*)
5. ``cd user_guide_src``