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

DOC: Update CookBook README

parent a847d289
Branches
Tags
No related merge requests found
...@@ -11,13 +11,15 @@ The old Cookbook in otb-documents is deprecated. ...@@ -11,13 +11,15 @@ The old Cookbook in otb-documents is deprecated.
Requirements Requirements
============ ============
install OTB, sphinx, sphinx-rtd-theme Install OTB, sphinx, sphinx-rtd-theme:
aptitude install python-sphinx python-sphinx-rtd-theme aptitude install python-sphinx python-sphinx-rtd-theme
How to build the Cookbook: How to build the Cookbook:
========================== ==========================
You will need a build of OTB with python wrapping enabled (SuperBuild is fine). Then:
mkdir ~/build-cookbook mkdir ~/build-cookbook
cd ~/build-cookbook cd ~/build-cookbook
cmake ~/sources/otb/Documentation/CookBook -DOTB_DIR=/path/where/you/installed/otb/lib/cmake/OTB-X.Y cmake ~/sources/otb/Documentation/CookBook -DOTB_DIR=/path/where/you/installed/otb/lib/cmake/OTB-X.Y
...@@ -26,6 +28,8 @@ How to build the Cookbook: ...@@ -26,6 +28,8 @@ How to build the Cookbook:
View results View results
============ ============
Open the cookbook documentation in a firefox tab! Open the cookbook documentation in a browser tab:
firefox ~/build-cookbook/rst/_build/html/index.html
firefox ~/build-cookbook/rst/_build/html/index.html To upload it somewhere, copy the _build/html directory.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment