opencv/doc
2011-01-11 20:51:08 +00:00
..
latex2sphinx
papers
pics
plastex
python_fragments
vidsurv
calib3d.tex
CMakeLists.txt
common.m4
core_array_operations.tex
core_basic_structures.tex
core_clustering_search.tex
core_drawing_functions.tex
core_dynamic_structures.tex
core_introduction.tex
core_persistence.tex
core_utilities_system_functions.tex
CvAux.tex
cvcam.rtf
Doxyfile.in
FAQ.tex
features2d_common_detection_description.tex
features2d_detection_description.tex
features2d_dynamic_detectors.tex
features2d_object_categorization.tex
flann.tex
go
goman
haartraining.htm
helvetica.sty
highgui_qt.tex
highgui.tex
imgproc_feature_detection.tex
imgproc_histograms.tex
imgproc_image_filtering.tex
imgproc_image_transform.tex
imgproc_image_warping.tex
imgproc_motion_tracking.tex
imgproc_object_detection.tex
imgproc_planar_subdivisions.tex
imgproc_struct_shape_analysis.tex
license.txt
ml.tex
objdetect.tex
online-opencv.tex
opencv_cheatsheet.pdf
opencv_cheatsheet.tex
opencv_guide_body.tex
opencv_user.pdf
opencv_user.tex
opencv-logo2.png
opencv-logo.png
opencv.bib
opencv.ico
opencv.jpg
opencv.pdf
opencv.sty
opencv.tex
opencvref_body.tex
packaging.txt
pattern.png
README.txt
user_mat.tex
verbdef.sty
video_motion_tracking.tex

This file describes how to create the opencv.pdf manual in the
.../opencv/doc directory. It further describes how to produce
the html files on disk that populate the online OpenCV documenation
wiki.

-------------------------------------------------------------------------
In Ubuntu or Debian, required to build the opencv.pdf manual:

  sudo apt-get install     texlive texlive-latex-extra latex-xcolor texlive-fonts-extra
 
To build the HTML documentation, these are also required:

  sudo apt-get install python-setuptools             ## See [1] below for another install method
  sudo easy_install -U Sphinx                        ## This is NOT the speech recognition program. 
  sudo apt-get install     dvipng
  sudo easy_install plasTeX            

-------------------------------------------------------------------------
In other Linux distros you will also need to install LiveTeX and,
optionally, if you want to produce the hmtl files, the Sphinx tool (http://sphinx.pocoo.org/)

In MacOSX you can use MacTex (https://www.tug.org/mactex/).

In Windows you can use MiKTeX

--------------------------------------------------------------------------
(1) To build the latex files to create the opencv.pdf manual, in the 
.../opencv/doc directory, issue the command:

sh go

(2) If you want to build the html files that OpenCV uses to populate the 
online documentation, assuming you downloaded easy_install, 
Sphinx and plasTex as above, then from the .../opencv/doc/latex2sphinx directory, 
issue the "buildall" commend there:

sh buildall

The resulting html files will be be created in:  
.../opencv/doc/latex2sphinx/_build/html

Under this html directory, you will find index.html files for:
  cpp   The C++ manual
  c     The C manual
  py    The Python manual

--------------------------------------------------------------------------
[1] To install easy install on Ubuntu, try either (as stated above):
 sudo apt-get install python-setuptools
 or try using:
First:
  wget -q http://peak.telecommunity.com/dist/ez_setup.py
Then
  sudo python ez_setup.py