Skip to content

doc: fix formulas in JavaDoc broken after Doxygen upgrade#25180

Merged
opencv-pushbot merged 1 commit intoopencv:4.xfrom
mshabunin:doc-fix-javadoc
Mar 14, 2024
Merged

doc: fix formulas in JavaDoc broken after Doxygen upgrade#25180
opencv-pushbot merged 1 commit intoopencv:4.xfrom
mshabunin:doc-fix-javadoc

Conversation

@mshabunin
Copy link
Copy Markdown
Contributor

@mshabunin mshabunin commented Mar 7, 2024

Restored variable defining MathJax path.

https://github.com/opencv/opencv/pull/25042/files#r1515290130

force_builders_only=docs

@opencv-alalek opencv-alalek added bug category: documentation Documentation fix or update labels Mar 7, 2024
@opencv-alalek
Copy link
Copy Markdown
Contributor

Looks like it still doesn't work.

Search for The function smooths an image using the kernel on these pages:

@opencv-alalek opencv-alalek added this to the 4.10.0 milestone Mar 7, 2024
@mshabunin
Copy link
Copy Markdown
Contributor Author

It should mostly work now, I've replaced Header attribute in Ant task with bottom, because Header is included on the
page twice and causes creation of two identical script elements which probably breaks MathJax 3. This behavior can be seen in the current 4.9.0 documentation too:
image

Additionally I've explicitly added ams package, however it should be loaded automatically even without this code (https://docs.mathjax.org/en/latest/web/components/combined.html#tex-chtml).

My local version works well (I checked Aruco), but BuildBot result sometimes do not render our custom macros. This problem goes away when cached scripts are used. I don't know why it happens, scripts seem to be added in correct order and should be executed as described in the MathJax documentation (https://docs.mathjax.org/en/latest/web/configuration.html#using-a-local-file-for-configuration)

When cache is cleared (sometimes all formulas are broken):
image

When cache is working:
image

Copy link
Copy Markdown
Contributor

@opencv-alalek opencv-alalek left a comment

Choose a reason for hiding this comment

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

Well done 👍

@opencv-alalek opencv-alalek self-assigned this Mar 13, 2024
@opencv-pushbot opencv-pushbot merged commit 372b3fe into opencv:4.x Mar 14, 2024
@mshabunin mshabunin deleted the doc-fix-javadoc branch March 14, 2024 08:38
@asmorkalov asmorkalov mentioned this pull request Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug category: documentation Documentation fix or update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants