OpenCV reference documentation integration for Qt Creator (.qch)

asked 2015-01-22 03:19:21 -0600

none
21 ●1

The Qt Creator "IDE" allows third party documentation to be used. However, I have not found OpenCV documentation in the required format. Apparently it is also possible to generate such a file from HTML documentation: http://qt-project.org/doc/qt-4.8/qthe...

But OpenCV uses Sphinx for documentation: http://docs.opencv.org/ Sphinx could generate those files but I don't know how this works: http://sphinx-doc.org/builders.html#s...

The documentation (generator) sources are at: https://github.com/Itseez/opencv/tree...

Qt says at http://qt-project.org/wiki/Qt_Creator... "CMake 3.0.0 and upwards can use Sphinx to generate a .qch file. "

answered 2016-02-01 15:59:18 -0600

--marc
31 ●2 ●4

updated 2016-02-02 14:00:23 -0600

I was able to build a mostly-complete .qch for OpenCV 3.1.0 as follows...

Main Build

cd PATH_TO/opencv-3.1.0
mkdir build; cd build
cmake -D CMAKE_INSTALL_PREFIX=/opt/opencv/3.1.0-qt5-gl \
      -D WITH_QT=5 \
      -D WITH_OPENGL=ON \
      -D WITH_OPENCL=OFF \
      -D BUILD_DOCS=ON \
      -D CMAKE_DOXYGEN_GENERATE_QHP=ON \
      -D CMAKE_BUILD_TYPE=RELEASE  ..
make -j7

Documents Build

cd doc  # goto PATH_TO/opencv-3.1.0/build/doc
make help
    The following are some of the valid targets for this Makefile:
   [...snip...]
    ... doxygen
    ... test
    ... package_source
    ... install/local

make -j7 doxygen

cd doc/doxygen/html
qhelpgenerator index.qhp -o opencv-3.1.0.qch

NOTE: In my case, there was a unmatched, dangling </section> tag at line 37157. If needed, comment out this line and rerun qhelpgenerator.

edit flag offensive delete link

add a comment

OpenCV reference documentation integration for Qt Creator (.qch)

1 answer

Links

Question Tools

Stats

Related questions

OpenCV reference documentation integration for Qt Creator (.qch) edit

1 answer

Links

Question Tools

Stats

Related questions

OpenCV reference documentation integration for Qt Creator (.qch)