From 62ab56c20ed5e821f3f7d2153a1800f08fa05452 Mon Sep 17 00:00:00 2001 From: Victor Poughon <victor.poughon@cnes.fr> Date: Mon, 18 Mar 2019 16:42:24 +0000 Subject: [PATCH] DOC: add compiling documentation subsection --- .../Cookbook/rst/CompilingOTBFromSource.rst | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/Documentation/Cookbook/rst/CompilingOTBFromSource.rst b/Documentation/Cookbook/rst/CompilingOTBFromSource.rst index d5fa3737f2..7961cc02b4 100644 --- a/Documentation/Cookbook/rst/CompilingOTBFromSource.rst +++ b/Documentation/Cookbook/rst/CompilingOTBFromSource.rst @@ -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 -- GitLab