summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2017-07-21 10:59:51 +0200
committerGitHub <noreply@github.com>2017-07-21 10:59:51 +0200
commit6cdfed28389842c30d3d9a0022de4aa1791b23e9 (patch)
tree7edd6b5a4da8f54d3d16d00b6b24b03094ba0465 /user_guide_src
parentb7ae9d4cd171e1674022c95100798cc7ada7572a (diff)
parent9cce9b7dd19ab6843af6925a1910cdf0924f0736 (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')
-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``