Documentation transition to fresh Doxygen #25042
Conversation
|
Ubuntu 22.04 ships Doxygen 1.9.1. relates #24643 |
Yes, but it is quite easy to install the latest version from tarball (https://www.doxygen.nl/download.html) or from sources. 1.9.1 have more issues breaking our documentation or invalid warnings. Major problem with this transition is that we can not (or it will be hard to) do it smoothly without breaking compatibility with old version. |
|
Updated Docker images for CI: opencv-infrastructure/opencv-gha-dockerfile#34 |
mshabunin
changed the title
Documentation transition to fresh Doxygen #3638 Merge with opencv/opencv#25042
Documentation transition to fresh Doxygen (5.x) #25161 Port of #25042 Merge with opencv/opencv_contrib#3687 CI part: opencv/ci-gha-workflow#162
| @@ -191,6 +195,8 @@ if(DOXYGEN_FOUND) | |||
| list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/tutorial-utils.js") | |||
| string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_HTML_FILES "${CMAKE_DOXYGEN_HTML_FILES}") | |||
|
|
|||
| set(OPENCV_MATHJAX_RELPATH "https://cdn.jsdelivr.net/npm/mathjax@3.0.1" CACHE STRING "URI to a MathJax installation") | |||
There was a problem hiding this comment.
if(DOXYGEN_FOUND)
OPENCV_MATHJAX_RELPATH
This variable is used in Javadoc too which could be build without Doxygen.
Moving from the root CMake script is wrong.
P.S. History is broken due to removal.
|
I've found another issue with new documentation - toggle buttons with code snippets in some tutorials do not work as expected:
I'm looking into it. |
Documentation transition to fresh Doxygen opencv#25042 * current Doxygen version is 1.10, but we will use 1.9.8 for now due to issue with snippets (doxygen/doxygen#10584) * Doxyfile adapted to new version * MathJax updated to 3.x * `@relates` instructions removed temporarily due to issue in Doxygen (to avoid warnings) * refactored matx.hpp - extracted matx.inl.hpp * opencv_contrib - opencv/opencv_contrib#3638
@relatesinstructions removed temporarily due to issue in Doxygen (to avoid warnings)