Skip to content

jquery.js has become obsolete in doxygen#9321

Open
albert-github wants to merge 6 commits intoCGAL:mainfrom
albert-github:feature/bug_jquery_js
Open

jquery.js has become obsolete in doxygen#9321
albert-github wants to merge 6 commits intoCGAL:mainfrom
albert-github:feature/bug_jquery_js

Conversation

@albert-github
Copy link
Copy Markdown
Contributor

As off doxygen/doxygen@c13c5f7 (February 09, 2026) the usage if jquery has been removed completely from doxygen, so the file is nut present in the (master) version of doxygen anymore and is removed from the header files. Furthermore some old (obsolete since doxygen 1.14.0 / 1.15.0) calls are removed and a double include has been removed.

As off doxygen/doxygen@c13c5f7 (February 09, 2026) the usage if jquery has been removed completely from doxygen, so the file is nut present in the (master) version of doxygen anymore and is removed from the header files.
Furthermore some old (obsolete since doxygen 1.14.0 / 1.15.0) calls are removed and a double include has been removed.
Small improvements for search box with packages.
jquery.js has become obsolete in doxygen but hacks.js still uses it, so adding jquery.js to hacks.js
The used jquery.js is the one that was used by doxygen without the side packages used by doxygen.
(other solutions, through doxygen settings,  fail as it should only be applied to master / forthcoming releases)
Code folding is also split as a separate js file (from dynsections.js) but not used by CGAL, so we set also the `HTML_CODE_FOLDING` to `No` so we don't need the js file (and its initial setting)
dynamic sections are used, but the dynsections.js is now properly protected in the doxygen code, so the variable `HTML_DYNAMIC_SECTIONS` should be set to `YES`
@albert-github
Copy link
Copy Markdown
Contributor Author

albert-github commented Feb 19, 2026

Ready to be tested, would be nice to have this in the overnight, documentation, testing as well.

@afabri afabri added this to the 6.2-beta milestone Feb 19, 2026
@albert-github
Copy link
Copy Markdown
Contributor Author

The fact that the overnight documentation build CGAL-6.2-Ic-114 (see https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/) didn't build is also a consequence of the recent changes in doxygen i.e. the dynsections.js is only written by doxygen when HTML_DYNAMIC_SECTIONS=YES (default in NO).

@albert-github
Copy link
Copy Markdown
Contributor Author

Ping to set this proposed PR to "Under testing" (so we see again results of the overnight documentation master builds)

Error occurs in he post processing in the call of:

    re_replace_in_file("'src','ftv2",
                       "'src','../Manual/ftv2",
                       os.path.join('Manual','dynsections.js') )

of Documentation/doc/scripts/html_output_post_processing.py
but as written in #9321 (comment) for the master version now the setting HTML_DYNAMIC_SECTIONS=YES has to be present.

@sloriot
Copy link
Copy Markdown
Member

sloriot commented Mar 3, 2026

Instead of shipping a copy of jquery, we should probably get rid of our usage? It's not clear to me where we need it.

@albert-github
Copy link
Copy Markdown
Contributor Author

@sloriot
You need it in hack.js and most likely in statements starting like $(document) (and other statements starting with $)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants