opencv/doc/README.txt

   1 This file describes how to create the opencv.pdf manual in the
   2 .../opencv/doc directory. It further describes how to produce
   3 the html files on disk that populate the online OpenCV documenation
   4 wiki.
   5
   6 -------------------------------------------------------------------------
   7 In Ubuntu or Debian, required to build the opencv.pdf manual:
   8
   9   sudo apt-get install     texlive texlive-latex-extra latex-xcolor texlive-fonts-extra
  10
  11 To build the HTML documentation, these are also required:
  12
  13   sudo apt-get install python-setuptools             ## See [1] below for another install method
  14   sudo easy_install -U Sphinx                        ## This is NOT the speech recognition program.
  15   sudo apt-get install     dvipng
  16   sudo easy_install plasTeX
  17
  18 -------------------------------------------------------------------------
  19 In other Linux distros you will also need to install LiveTeX and,
  20 optionally, if you want to produce the hmtl files, the Sphinx tool (http://sphinx.pocoo.org/)
  21
  22 In MacOSX you can use MacTex (https://www.tug.org/mactex/).
  23
  24 In Windows you can use MiKTeX
  25
  26 --------------------------------------------------------------------------
  27 (1) To build the latex files to create the opencv.pdf manual, in the
  28 .../opencv/doc directory, issue the command:
  29
  30 sh go
  31
  32 (2) If you want to build the html files that OpenCV uses to populate the
  33 online documentation, assuming you downloaded easy_install,
  34 Sphinx and plasTex as above, then from the .../opencv/doc/plastex directory,
  35 issue the "go" commend there:
  36
  37 sh go
  38
  39 The resulting html files will be be created in:
  40 .../opencv/doc/plastex/_build/html
  41
  42 --------------------------------------------------------------------------
  43 [1] To install easy install on Ubuntu, try either (as stated above):
  44  sudo apt-get install python-setuptools
  45  or try using:
  46 First:
  47   wget -q http://peak.telecommunity.com/dist/ez_setup.py
  48 Then
  49   sudo python ez_setup.py