Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doxygen: fix doc compilation with Doxygen 1.10 or later #8665

Merged
merged 4 commits into from
Jan 6, 2025
Merged

Doxygen: fix doc compilation with Doxygen 1.10 or later #8665

merged 4 commits into from
Jan 6, 2025

Conversation

lrineau
Copy link
Member

@lrineau lrineau commented Dec 17, 2024 •
edited
Loading

  • Introduce container images for Doxygen.
  • Ensure compatibility with Doxygen 1.10 and later.
  • Revert previous stylesheet changes to restore the correct stylesheet path (reverts Remove hardcoded extrastylesheet code #8331).

@lrineau lrineau mentioned this pull request Dec 17, 2024
Merged
@lrineau
add container images for Doxygen
18a542b
@lrineau
cgal_stylesheet.css must be taken from ../Manual
a269cd3 
Revert "Merge pull request CGAL#8331 from albert-github/feature/bug_cgal_stylesheet"

This reverts commit 62de71b, reversing
changes made to 3b4349c.
@lrineau
fix build with Doxygen 1.10 and later
5eddbc2
@lrineau lrineau force-pushed the CGAL-fix_doxygen_1.10-GF branch from ecb5b2a to 5eddbc2 Compare December 17, 2024 14:49
@lrineau lrineau added this to the 6.0.2 milestone Dec 17, 2024
@lrineau lrineau changed the base branch from master to 6.0.x-branch December 17, 2024 14:58
@lrineau lrineau assigned lrineau and sloriot and unassigned lrineau Dec 17, 2024
@lrineau
Copy link
Member Author

lrineau commented Dec 17, 2024

  • @sloriot Please review my changes in Documentation/doc/CMakeLists.txt.
  • @albert-github Please review my changes in Documentation/doc/resources/*/.

@lrineau lrineau requested a review from sloriot December 17, 2024 15:01
@albert-github
Copy link
Contributor

I had a quick look at the changes in Documentation/doc/resources/*/ but I miss the rationale behind it.
As far as I know the version as introduced in #8331 works correctly and is conform the doxygen way to do it so I dont understand the "Revert previous stylesheet changes to restore the correct stylesheet path"

@sloriot sloriot added Under Testing Not yet approved The feature or pull-request has not yet been approved. and removed Under Testing Ready to be tested labels Dec 23, 2024
@sloriot
Copy link
Member

sloriot commented Dec 27, 2024

Successfully tested in CGAL-6.1-Ic-50

@sloriot sloriot added the Tested label Dec 27, 2024
@lrineau
Copy link
Member Author

lrineau commented Jan 6, 2025

I had a quick look at the changes in Documentation/doc/resources/*/ but I miss the rationale behind it. As far as I know the version as introduced in #8331 works correctly and is conform the doxygen way to do it so I dont understand the "Revert previous stylesheet changes to restore the correct stylesheet path"

The CGAL documentation is not the traditional doxygen documentation: it consists of about 120 different Doxygen documentations, linked using Doxygen tags.

To reduce the duplication of common files, there are several of them that are taken from the Manual/ directory, and we have a script that removes all the ones in other package.

For example, in https://doc.cgal.org/latest/Triangulation_2/index.html, we have :

<link href="../Manual/cgal_stylesheet.css" rel="stylesheet" type="text/css">
<link href="../Manual/doxygen.css" rel="stylesheet" type="text/css">
<link href="../Manual/search/search.css" rel="stylesheet" type="text/css">
<link rel="icon" type="image/png" href="../Manual/g-196x196-doc.png">
<script src="../Manual/hacks.js" type="text/javascript"></script>
<script type="text/javascript" src="../Manual/dynsections.js"></script>
<script type="text/javascript" src="../Manual/jquery.js"></script>
<script type="text/javascript" src="../Manual/resize.js"></script>
<script type="text/javascript" src="../Manual/search/searchdata.js"></script>
<script type="text/javascript" src="../Manual/search/search.js"></script>

cgal_stylesheet.css is just one of those files. The PR #8331 is the cause of the issue #8645, because for all CGAL packages (except for Manual/), the access to cgal_stylesheet.css gives an HTTP error 404 (not found).

@lrineau lrineau removed the Not yet approved The feature or pull-request has not yet been approved. label Jan 6, 2025
@lrineau lrineau merged commit e9a2365 into CGAL:6.0.x-branch Jan 6, 2025
9 checks passed
@lrineau lrineau deleted the CGAL-fix_doxygen_1.10-GF branch January 6, 2025 15:38
@lrineau lrineau mentioned this pull request Jan 6, 2025
Closed
@sloriot
Copy link
Member

sloriot commented Jan 6, 2025

I'm pretty sure I added "not yet approved" meaning I wanted to review the PR before the merge...

@albert-github
Copy link
Contributor

I don't think this is fixed as I still see the problem in the current overnight build: https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-6.1-Ic-57/master/Algebraic_foundations/index.html#Chapter_Algebraic_Foundations

See issue #8645

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

@sloriot sloriot Awaiting requested review from sloriot

Assignees

@sloriot sloriot

Labels
Bug Doc Infrastructure Tested
Projects
None yet
Milestone
6.0.2
Development

Successfully merging this pull request may close these issues.
3 participants
@lrineau @albert-github @sloriot