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

Building documentation section: now with a non-stupid way of doing it! And other minor fixes.

develop
TheBloke 2015-12-15 04:10:00 +00:00
parent 21631b3712
commit 5aae535394
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/Compile.rst
Unescape Escape View File

@ -441,15 +441,10 @@ Enabling documentation building
First, make sure you have followed all the necessary steps for your platform as outlined First, make sure you have followed all the necessary steps for your platform as outlined
in the rest of this document. in the rest of this document.
#. Edit ``CMakeLists.txt`` in the root folder of your dfhack directory. Then, to compile documentation with DFHack, pass the flag ``-DBUILD_DOCS:bool=ON`` to cmake.
#. Find the line:: For example::
OPTION(BUILD_DOCS "Choose whether to build the documentation (requires python and Sphinx)." OFF) cmake .. -DCMAKE_BUILD_TYPE:string=Release -DBUILD_DOCS:bool=ON -DCMAKE_INSTALL_PREFIX=<path to DF>
#. Change ``OFF`` to ``ON`` and save.
#. Now compile as normal, and the .rst documents will be compiled to HTML in
``/docs/html/docs/`` under your dfhack directory.
#. If you are committing to DFHack, be sure not to add your changed ``CMakeLists.txt`` to any commit.
Required dependencies Required dependencies