Skip to content

Documentation transition to fresh Doxygen#25042

Merged
asmorkalov merged 13 commits intoopencv:4.xfrom
mshabunin:doc-upgrade
Mar 5, 2024
Merged

Documentation transition to fresh Doxygen#25042
asmorkalov merged 13 commits intoopencv:4.xfrom
mshabunin:doc-upgrade

Conversation

@mshabunin
Copy link
Copy Markdown
Contributor

@mshabunin mshabunin commented Feb 16, 2024 •
edited
Loading 

force_builders_only=docs
build_image:Docs=docs:22.04
buildworker:Docs=linux-4

@opencv-alalek
Copy link
Copy Markdown
Contributor

opencv-alalek commented Feb 17, 2024 •
edited
Loading

Ubuntu 22.04 ships Doxygen 1.9.1.

relates #24643

@mshabunin
Copy link
Copy Markdown
Contributor Author

mshabunin commented Feb 17, 2024

Ubuntu 22.04 ships Doxygen 1.9.1.

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.

This was referenced Feb 17, 2024
Merged
Merged
@mshabunin
Copy link
Copy Markdown
Contributor Author

mshabunin commented Feb 19, 2024

Updated Docker images for CI: opencv-infrastructure/opencv-gha-dockerfile#34

@mshabunin mshabunin changed the title Documentation transition to Doxygen 1.10 Documentation transition to fresh Doxygen Feb 19, 2024
@mshabunin mshabunin marked this pull request as ready for review February 19, 2024 20:33
@mshabunin mshabunin mentioned this pull request Feb 19, 2024
Merged
asmorkalov
asmorkalov reviewed Feb 20, 2024
View reviewed changes
@dkurt dkurt linked an issue Feb 28, 2024 that may be closed by this pull request
Problem about Doxygen @tableofcontents #24643
Closed
@Kumataro Kumataro mentioned this pull request Mar 3, 2024
Closed
asmorkalov
asmorkalov approved these changes Mar 5, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@asmorkalov asmorkalov added this to the 4.10.0 milestone Mar 5, 2024
@asmorkalov asmorkalov added the category: documentation Documentation fix or update label Mar 5, 2024
@asmorkalov asmorkalov merged commit bf06e3d into opencv:4.x Mar 5, 2024
asmorkalov pushed a commit to opencv/opencv_contrib that referenced this pull request Mar 5, 2024
@mshabunin
Merge pull request #3638 from mshabunin:doc-upgrade
1aaf6e1 
Documentation transition to fresh Doxygen #3638

Merge with opencv/opencv#25042
@mshabunin mshabunin mentioned this pull request Mar 5, 2024
Merged
asmorkalov pushed a commit that referenced this pull request Mar 6, 2024
@mshabunin
Merge pull request #25161 from mshabunin:doc-upgrade-5.x
de29223 
Documentation transition to fresh Doxygen (5.x) #25161 

Port of #25042

Merge with opencv/opencv_contrib#3687
CI part: opencv/ci-gha-workflow#162
@asmorkalov asmorkalov mentioned this pull request Mar 6, 2024
Closed
opencv-alalek
opencv-alalek reviewed Mar 6, 2024
View reviewed changes
doc/CMakeLists.txt
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")
Copy link
Copy Markdown
Contributor

@opencv-alalek opencv-alalek Mar 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@mshabunin mshabunin deleted the doc-upgrade branch March 13, 2024 18:26
@mshabunin
Copy link
Copy Markdown
Contributor Author

mshabunin commented Mar 13, 2024

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.

@mshabunin mshabunin mentioned this pull request Mar 13, 2024
Merged
@asmorkalov asmorkalov mentioned this pull request Apr 1, 2024
Merged
@Kumataro Kumataro mentioned this pull request Apr 11, 2024
Closed
klatism pushed a commit to klatism/opencv that referenced this pull request May 17, 2024
@mshabunin @klatism
Merge pull request opencv#25042 from mshabunin:doc-upgrade
ee1cbe6 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@opencv-alalek opencv-alalek opencv-alalek left review comments

@asmorkalov asmorkalov asmorkalov approved these changes

Assignees

No one assigned

Labels

category: build/install category: documentation Documentation fix or update

Projects

None yet

Milestone

4.10.0

Development

Successfully merging this pull request may close these issues.

Problem about Doxygen @tableofcontents

3 participants

@mshabunin @opencv-alalek @asmorkalov