Skip to content
Snippets Groups Projects
Commit 62ab56c2 authored by Victor Poughon's avatar Victor Poughon
Browse files

DOC: add compiling documentation subsection

parent 11566658
Branches
Tags
No related merge requests found
......@@ -376,3 +376,32 @@ directory where you built OTB and run ``ctest -N`` to have a list of all
the tests. Just using ``ctest`` will run all the tests. To select a
subset, you can do ``ctest -R Kml`` to run all tests related to kml
files or ``ctest -I 1,10`` to run tests from 1 to 10.
Compiling documentation
-----------------------
To build the CookBook documentation, the following python packages are required:
``numpy, sphinx, sphinx_rtd_theme``. They are available on pip:
::
pip install numpy sphinx sphinx_rtd_theme
A working installation of ``latex`` is
required for building the PDF version.
Enable Python bindings and set ``BUILD_COOKBOOK``:
::
cmake -DOTB_WRAP_PYTHON=ON -DBUILD_COOKBOOK=ON .
Then, build the target:
::
make CookbookHTML
::
make CookBookPDF
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment