Documentation - Building from source

Given the extracted Sub-Directory of the documentation (no other directories) from the source code distribution, how, precisely, can I get the documentation build into HTML and PDF files.

Else, if it is not possible, then with the full source code distribution (will obtain it again)

NOTE: I would like to do it for opencv (core) and all others e.g. opencv_contrib , nonfree etc…

documentation is built using doxygen.
I don’t know a pdf file fro documentation? Where did you get it?
How to build documentation it’s here

@laurent.berger](Profile - laurent.berger - OpenCV)

I tried it. But during cmake running, it gives errors about missing components, and not being allowed to download them either, lots of them.

Can you give fool-proof step by step instructions, from scratch ? (include a ll steps such as download,extract,configuration,setup,configuration, etc… ),

I would like to do it for opencv (core) and all others e.g. opencv_contrib , nonfree etc…

Can you post cmakeoutput.txt?

@laurent.berger

Here they are,(did not allow being attached):

CMakeOutput.log
https://justpaste.it/CMakeOutput

CMakeError.log
https://justpaste.it/CMakeError

that’s only test. Don’t stop cmake process and post full cmake output and may be cmakecache.txt

@laurent.berger

Full Cmake Output:
http://justpaste.it/Full_Cmake_Output

cmakecache.txt
http://justpaste.it/CMakeCache

Some lines are missing in cmakeoutput

@laurent.berger

Yes. The following was output to StandardError stream:

CMake Error at CMakeLists.txt:779 (find_package):
  Could not find a package configuration file provided by "quirc" with any of
  the following names:

    quircConfig.cmake
    quirc-config.cmake

  Add the installation prefix of "quirc" to CMAKE_PREFIX_PATH or set
  "quirc_DIR" to a directory containing one of the above files.  If "quirc"
  provides a separate development package or SDK, be sure it has been
  installed.


-- Configuring incomplete, errors occurred!
See also "C:/OpenCV_Doc/BUILD/CMakeFiles/CMakeOutput.log".
See also "C:/OpenCV_Doc/BUILD/CMakeFiles/CMakeError.log".

Have you clone opencv?
delete cmakecache.txt start cmakegui

Have you clone opencv?
Yes, and opencv_contrib also.

I did as stated in https://docs.opencv.org/master/d4/db1/tutorial_documentation.html, :

Generate documentation

Get the OpenCV sources
Get the OpenCV_contrib sources
Create build directory near the sources folder(s) and go into it
Run cmake:

cmake -DBUILD_DOCS=ON -DOPENCV_EXTRA_MODULES_PATH=../opencv_contrib/modules ../opencv

delete cmakecache.txt start cmakegui

And do what with it?, (I never used it before)

delete cmakecache.txt That’s better. Post all cmake output after cmd cmake

You must get something like that

@laurent.berger

I did post all output. Here it is, after running again:
https://justpaste.it/9qycg

and here is a video of it in action:

try cmake -DWITH_QUIRC:BOOL=OFF

@laurent.berger

I still get more errors:

-- ADE: Download: v0.1.1f.zip
CMake Error at cmake/OpenCVDownload.cmake:161 (message):
      Downloads are not permitted during configure. Please pre-download the file "C:/OpenCV_Doc/OpenCV/.cache/ade/b624b995ec9c439cbc2e9e6ee940d3a2-v0.1.1f.zip":
      
      vcpkg_download_distfile(OCV_DOWNLOAD
          URLS "https://github.com/opencv/ade/archive/v0.1.1f.zip"
          FILENAME "opencv-cache/ade/b624b995ec9c439cbc2e9e6ee940d3a2-v0.1.1f.zip"
          SHA512 0
      )
Call Stack (most recent call first):
  modules/gapi/cmake/DownloadADE.cmake:5 (ocv_download)
  modules/gapi/cmake/init.cmake:19 (include)
  cmake/OpenCVModule.cmake:298 (include)
  cmake/OpenCVModule.cmake:361 (_add_modules_1)
  modules/CMakeLists.txt:7 (ocv_glob_modules)


-- Configuring incomplete, errors occurred!
See also "C:/OpenCV_Doc/BUILD/CMakeFiles/CMakeOutput.log".
See also "C:/OpenCV_Doc/BUILD/CMakeFiles/CMakeError.log".

Output:
https://justpaste.it/8atqk

try cmake -G"Visual Studio 16 2019" -A x64 -DWITH_QUIRC:BOOL=OFF
Are you behind a proxy?

there is an issue here Can't install OpenCV with ffmpeg · Issue #4696 · microsoft/vcpkg · GitHub

@laurent.berger

Not behind a proxy (Other command line utilities like GIT, are able to download files).

Same output using:

cmake -DBUILD_DOCS=ON -DOPENCV_EXTRA_MODULES_PATH=…/opencv_contrib/modules …/opencv -G"Visual Studio 16 2019" -A x64 -DWITH_QUIRC:BOOL=OFF

there is an issue here Can’t install OpenCV with ffmpeg · Issue #4696 · microsoft/vcpkg · GitHub

There is no ...\vcpkg\downloads\opencv-cache\ directory created.

There is a problem in your configuration. Where do you clone opencv (origin github.com/opencv)?

What is vckpg ? there is no no need of vckpg to build opencv

@laurent.berger

Clone source code To:

C:\OpenCV_Doc\OpenCV
C:\OpenCV_Doc\OpenCV_contrib

I am currently trying with the Latest version of the Source Code on GIT repository, and it is working, so far (still processing…)

@laurent.berger

With the latest source code, from the official GIT repositories. the cmake step completed without errors.

But when compiling the built project with Visual Studio. using the generated project files, there are build errors:

Severity Code Description Project File Line Suppression State
Error Illegal ALIASES format ‘text/javascript> addToggle(); @endhtmlonly’. Use name=value or name{n}=value, where n is the number of arguments doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running bibtex. Verify that the command ‘perl --version’ works from the command line. Exit code: 1 doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running dot: exit code=-1, command=‘dot’, arguments=‘C:/OpenCV_Doc/BUILD/doc/doxygen/html/inline_dotgraph_1.dot -Tsvg -o C:/OpenCV_Doc/BUILD/doc/doxygen/html/dot_inline_dotgraph_1.svg’ doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running dot: exit code=-1, command=‘dot’, arguments=‘C:/OpenCV_Doc/BUILD/doc/doxygen/html/inline_dotgraph_1.dot -Tcmapx -o C:/OpenCV_Doc/BUILD/doc/doxygen/html/dot_inline_dotgraph_1.map’ doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running dot: exit code=-1, command=‘dot’, arguments=‘C:/OpenCV_Doc/BUILD/doc/doxygen/html/inline_dotgraph_2.dot -Tsvg -o C:/OpenCV_Doc/BUILD/doc/doxygen/html/dot_inline_dotgraph_2.svg’ doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running dot: exit code=-1, command=‘dot’, arguments=‘C:/OpenCV_Doc/BUILD/doc/doxygen/html/inline_dotgraph_2.dot -Tcmapx -o C:/OpenCV_Doc/BUILD/doc/doxygen/html/dot_inline_dotgraph_2.map’ doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running dot: exit code=-1, command=‘dot’, arguments=‘C:/OpenCV_Doc/BUILD/doc/doxygen/html/inline_dotgraph_3.dot -Tsvg -o C:/OpenCV_Doc/BUILD/doc/doxygen/html/dot_inline_dotgraph_3.svg’ doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error Problems running dot: exit code=-1, command=‘dot’, arguments=‘C:/OpenCV_Doc/BUILD/doc/doxygen/html/inline_dotgraph_3.dot -Tcmapx -o C:/OpenCV_Doc/BUILD/doc/doxygen/html/dot_inline_dotgraph_3.map’ doxygen_cpp C:\OpenCV_Doc\BUILD\doc\CUSTOMBUILD 1
Error MSB8066 Custom build for ‘C:\OpenCV_Doc\BUILD\CMakeFiles\10d41d57a77342e4a3100f8f5e8ed012\doxygen_cpp.rule’ exited with code -1. doxygen_cpp C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\MSBuild\Microsoft\VC\v160\Microsoft.CppCommon.targets 238

I will download the official pre-built Documentation, from the GIT repository’s release.