From 5648adbc2cbcb1d36c13e447d508864d212c6f80 Mon Sep 17 00:00:00 2001 From: TheBloke Date: Tue, 22 Dec 2015 01:39:39 +0000 Subject: [PATCH] Linux: Building docs: Some clarification on pip and sphinx-build --- docs/Compile.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/Compile.rst b/docs/Compile.rst index e22e99556..106a5cbc9 100644 --- a/docs/Compile.rst +++ b/docs/Compile.rst @@ -532,18 +532,26 @@ for example. To avoid doubt, ``pip`` can be used instead as detailed below. Linux ----- -Most Linux distributions will include Python as standard, including the pip -package manager. +Most Linux distributions will include Python as standard. Check your package manager to see if Sphinx 1.3.1 or later is available, but at the time of writing Ubuntu for example only has 1.2.x. -You can instead install the Python module with:: +You can instead install Sphinx with the pip package manager. This may need +to be installed from your OS package manager; this is the case on Ubuntu. +On Ubuntu/Debian, use the following to first install pip:: + + sudo apt-get install python-pip + +Once pip is available, you can then install the Python Sphinx module with:: pip install sphinx If you run this as a normal user it will install a local copy for your user only. -Run it with sudo if you want a system-wide install. Either is fine for DFHack. +Run it with sudo if you want a system-wide install. Either is fine for DFHack, +however if installing locally do check that ``sphinx-build`` is in your path. +It may be installed in a directory such as ``~/.local/bin/``, so after pip +install, find ``sphinx-build`` and ensure its directory is in your local ``$PATH``. Mac OS X