From f26982f1e999b8f1f8fe6e67a04e0be49338d7e7 Mon Sep 17 00:00:00 2001 From: TheBloke Date: Tue, 15 Dec 2015 04:11:39 +0000 Subject: [PATCH] And other minor fixes (actually in this commit this time.) --- docs/Compile.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/Compile.rst b/docs/Compile.rst index 49bad1502..93d7c5d23 100644 --- a/docs/Compile.rst +++ b/docs/Compile.rst @@ -26,16 +26,14 @@ To get the latest release code (master branch):: If your version of git does not support the ``--recursive`` flag, you will need to omit it and run ``git submodule update --init`` after entering the dfhack directory. -To get the latest development code (develop branch):: +To get the latest development code (develop branch), clone as above and then:: - git clone --recursive https://github.com/DFHack/dfhack - cd dfhack git checkout develop git submodule update **Important note on submodule update**: -It is necessary to run ``git submodule update`` every time you change Git branch, +You must run ``git submodule update`` every time you change Git branch, for example when switching between master and develop branches and back. @@ -454,11 +452,12 @@ version 1.3.1 or later. Both Python 2.x and 3.x are supported. When installing Sphinx from OS package managers, be aware that there is another program called Sphinx, completely unrelated to documentation management. -Be sure you are installing the right Sphinx! +Be sure you are installing the right Sphinx; it may be called ``python-sphinx``, +for example. To avoid doubt, pip can be used instead as detailed below. Linux ------PTION(BUILD_DOCS "Choose whether to build the documentation (requires python and Sphinx)." ON) +----- Most Linux distributions will include Python as standard, including the pip package manager.