RST docs for Orfeo Toolbox CookBook
This file is renamed to README.md even though the syntax is rst and not markdown. The motive is to prevent it from including in the Cookbook
This is an alternative/replacement of current OTB Cookbook which is written in Latex. This version is completely deviate from existing Latex format to reStructured format (rst). Home page of rst says, reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. Indeed, every bit is true from our experience. You can find more about rst, and its syntax from here http://docutils.sourceforge.net/rst.html. Using sphinx build tools, rst can be converted to formats including but not limited to html, pdf, latex!.
Converting existing latex to rst is not that straightforward. All rst files for OTB applications are generated using python script otbGenerateWrappersRstDoc.py. For others in recipes, we used a tool called pandoc to get an inital rst and then edited out errors manually. You do not have to generate them again.
-
cd $HOME
-
clone this repository git clone http://github.com/rashadkm/rstdocs
-
Go to rstdocs directory cd rstdocs
-
install sphinx-quickstart to configure and build rst docs.
- you can install it via pip
- pip install sphinx
- use your favourite package manager
- you can install it via pip
-
To make html docs, Run: make html
-
To make pdf docs, Run: make pdf
NOTE: you can easily update these files manually. Do not try to generate these files again unless,
-
if you have major change in application documentation which is currently updated in the sources.
-
If you really want to do so
a) Install OTB python wrapping
For Fedora 20 / 21, you can install OTB from Fedora Copr repository https://copr.fedoraproject.org/coprs/orfeotoolbox/otb/
# dnf copr enable orfeotoolbox/otb
# yum install -y otb-python
b) python otbGenerateWrappersRstDoc.py
4.1 If you get below error:
Traceback (most recent call last): File "otbGenerateWrappersRstDoc.py", line 2, in import otbApplication ImportError: No module named otbApplication
please add path to otbApplication.py to your PYTHONPATH and relauch python scirpt