MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

And other minor fixes (actually in this commit this time.)

develop
TheBloke 2015-12-15 04:11:39 +00:00
parent 5aae535394
commit f26982f1e9
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/Compile.rst
Unescape Escape View File

@ -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 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. ``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 checkout develop
git submodule update git submodule update
**Important note on 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. 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 When installing Sphinx from OS package managers, be aware that there is
another program called Sphinx, completely unrelated to documentation management. 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 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 Most Linux distributions will include Python as standard, including the pip
package manager. package manager.