How to build docs for opencv-3.0.0-rc1

asked 2015-04-28 22:35:26 -0500

dslate1 gravatar image

updated 2015-04-29 02:01:47 -0500

berak gravatar image

I built opencv-3.0.0-rc1 on my "Ubuntu 14.04.2 LTS" system (Linux lyta4 3.13.0-49-generic #81-Ubuntu SMP Tue Mar 24 19:29:48 UTC 2015 x86_64 x86_64 x86_64 GNU/Linux) using these commands:

VERS=opencv-3.0.0-rc1
DIR=/home/dave/maclearn/vision/opencv/$VERS
rm -rf $DIR
unzip $VERS.zip
cd $DIR
mkdir build
cd build
cmake -D CMAKE_INSTALL_PREFIX=/usr/local/$VERS \
    -D WITH_TBB=ON -D BUILD_NEW_PYTHON_SUPPORT=ON -D WITH_V4L=ON \
    -D INSTALL_C_EXAMPLES=ON -D INSTALL_PYTHON_EXAMPLES=ON -D BUILD_DOCS=ON \
    -D BUILD_EXAMPLES=ON -D WITH_QT=ON -D WITH_OPENGL=ON -D WITH_IPP=OFF ..
cd $DIR/build
make
make docs

However, apparently the docs were not made. Previously I used the same script to build opencv-3.0.0-beta, and the docs, including several PDF files, were built successfully. It looks like there were changes between opencv-3.0.0-beta and opencv-3.0.0-rc1 in how the docs are built.

In the "General configuration for OpenCV 3.0.0-beta" section of my build log for opencv-3.0.0-beta I see:

--   Documentation:
--     Build Documentation:         YES
--     Sphinx:                      /usr/bin/sphinx-build (ver 1.2.2)
--     PdfLaTeX compiler:           /usr/bin/pdflatex
--     PlantUML:                    NO
--     Doxygen:                     YES (/usr/bin/doxygen)

In the "General configuration for OpenCV 3.0.0-rc1" section of my build log for OpenCV 3.0.0-rc1 I see:

--   Documentation:
--     Doxygen:                     /usr/bin/doxygen (ver 1.8.6)
--     PlantUML:                    NO

Any ideas on how I can build the docs for OpenCV 3.0.0-rc1?

Thanks.

edit retag flag offensive close merge delete

Comments

2

hmm, i'm on win, but building the doxygen target produced docs. did you try make doxygen ? (blind guess)

berak gravatar imageberak ( 2015-04-29 02:03:24 -0500 )edit

@berak is right, it is make doxygen. Please, see documentation writing guide for some details.

mshabunin gravatar imagemshabunin ( 2015-04-29 03:39:53 -0500 )edit
1

Thanks for your help. I did "make doxygen" and it produced documentation in html format. For various reasons I tend to prefer pdf format docs, which I was able to produce for previous versions, including opencv-3.0.0-beta. Is it still possible to get pdf files, or does that no longer make sense for OpenCV 3.0.0-rc1?

dslate1 gravatar imagedslate1 ( 2015-04-29 05:39:49 -0500 )edit

@dslate1, doxygen can produce pdf, but you need to modify Doxyfile to enable it and this process is not well tested for OpenCV. Please, see doxygen manual for details.

mshabunin gravatar imagemshabunin ( 2015-04-30 03:03:09 -0500 )edit