Trouble building documentation/tutorials [closed]
I want to work on fixing the Detection of ArUco Markers tutorial in this GitHub issue. I've made contributions to opencv and opencv_contrib so I'm familiar with building opencv and making pull requests. But now I'm running into problems trying to build the documentation and tutorials. I have Doxygen installed (via Homebrew) and I followed the instructions at Writing documentation for OpenCV.
When I run make doxygen all of the copying… steps seem to complete successfully, but at the Generate Doxygen documentation step I get a large number "unable to resolve reference" of warnings. Here's an excerpt:
/Users/steve/Documents/GitHub/ssteve-opencv/build/doc/contrib_tutorials.markdown:3: warning: unable to resolve reference to 'tutorial_table_of_content_aruco' for \ref command
/Users/steve/Documents/GitHub/ssteve-opencv/build/doc/contrib_tutorials.markdown:4: warning: unable to resolve reference to 'tutorial_table_of_content_bgsegm' for \ref command
/Users/steve/Documents/GitHub/ssteve-opencv/build/doc/contrib_tutorials.markdown:5: warning: unable to resolve reference to 'tutorial_table_of_content_retina' for \ref command
/Users/steve/Documents/GitHub/ssteve-opencv/build/doc/contrib_tutorials.markdown:6: warning: unable to resolve reference to 'tutorial_omnidir_calib_main' for \ref command
/Users/steve/Documents/GitHub/ssteve-opencv/build/doc/contrib_tutorials.markdown:7: warning: unable to resolve reference to 'tutorial_multi_camera_main' for \ref command
The build/doc/doxygen/html directory is created and includes index.html and many other files, but the links to the modules haven't been created. Are there more steps to building the documentation and tutorials than are included at Writing documentation for OpenCV?
you don't need to compile the documentation locally. when you create a PR the documentation including related changes will be created on pullrequest.opencv.org you can edit and see the changes
But is it possible to build the documentation locally? If I edit a tutorial markdown file I'd like to see the resulting html that Doxygen creates. Also, this raises the issue that the instructions at Writing Documentation for OpenCV are incorrect.
of course it is possible to build the documentation locally
Then that brings us back to my original question. Is there something missing from Writing documentation for OpenCV?