Skip to content

O
opencv
Switch branch/tag
History Find file
Name
Last commit
 Last update
..
_static removed obsolete docs
_themes/blue moved the new docs from docroot to doc
opencv1 fixed formatting a bit
opencv2 converted user guide & tutorials from tex to rst; added them into the whole documentation tree; added html_docs target.
pattern_tools adding better support for asymmetric patterns.
pics repaired opencv refman & refman1 build
python_fragments #301, sample code for CalcHist
tutorials converted user guide & tutorials from tex to rst; added them into the whole documentation tree; added html_docs target.
user_guide added the link in doc on kinect
vidsurv "atomic bomb" commit. Reorganized OpenCV directory structure
CMakeLists.txt converted user guide & tutorials from tex to rst; added them into the whole documentation tree; added html_docs target.
Doxyfile.in doxygenated opencv_video & opencv_calib3d modules (C++ part only)
README.txt Updated for building in latexsphinx directory
acircles_pattern.png Added a printable asymmetric pattern of circles
conf.py converted user guide & tutorials from tex to rst; added them into the whole documentation tree; added html_docs target.
haartraining.htm "atomic bomb" commit. Reorganized OpenCV directory structure
license.txt "atomic bomb" commit. Reorganized OpenCV directory structure
mymath.sty moved the new docs from docroot to doc
opencv-logo.png "atomic bomb" commit. Reorganized OpenCV directory structure
opencv-logo2.png "atomic bomb" commit. Reorganized OpenCV directory structure
opencv.bib added documentation on LatentSVM algorithm
opencv.ico remove interfaces from installation; remove opencv/utils dir completely
opencv.jpg "atomic bomb" commit. Reorganized OpenCV directory structure
opencv.pdf added asynchronous versions of transform- and projectPoints into the GPU module, added docs
opencv_cheatsheet.pdf updated version number; removed unnecessary index.html and ChangeLog.htm
opencv_cheatsheet.tex updated version number; removed unnecessary index.html and ChangeLog.htm
opencv_tutorials.pdf Tutorials
opencv_user.pdf English corrected
packaging.txt "atomic bomb" commit. Reorganized OpenCV directory structure
pattern.png replaced 8x6 pattern with 9x6, which orientation can be determined without any ambiguity
reformat.py moved the new docs from docroot to doc
README.txt 
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