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.

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

Defining a new resource directory to be used with doxygen master #7427

Closed

Conversation

albert-github
Copy link
Contributor

  • fix problem in search functionality
  • use default doxygen stylesheet and define differences in the extra strylesheet
  • remove non used file (compared to the 1.93 resource directory)

- fix problem in search functionality
- use default doxygen stylesheet and define differences in the extra strylesheet
- remove non used file (compared to the 1.93 resource directory)
@sloriot
Copy link
Member

sloriot commented May 12, 2023

Are those changes only for the upcoming 1.9.7 or are they also valid for 1.9.6?

@albert-github
Copy link
Contributor Author

I didn't test against the 1.9.6 version but I think it should be valid there as well with the exception of the (not used by CGAL) new settings MARKDOWN_ID_STYLE and MSCGEN_TOOL in BaseDoxyfile.in.

@albert-github
Copy link
Contributor Author

albert-github commented May 12, 2023

@sloriot Is there already a planned release date for CGAL 6.0 so I can check whether the doxygen version 1.9.6 or (the not yet released) doxygen version 1.9.7 would be more appropriate?

@sloriot
Copy link
Member

sloriot commented May 12, 2023

I'm working on your branch right now to move all to 1.9.6. There is a bug that I'm currently tracking.

@albert-github
Copy link
Contributor Author

What kind of bug do you see?

@sloriot
Copy link
Member

sloriot commented May 12, 2023

Screenshot from 2023-05-12 13-47-17

@albert-github
Copy link
Contributor Author

Do you mean that you get an unexpected page and an extra item Polygon Mesh Processing Reference in the generated tree?
(file: Polygon_mesh_processing/group__PkgPolygonMeshProcessingRef.html from the overnight build: https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-5.6-Ic-249/master/Polygon_mesh_processing/group__PkgPolygonMeshProcessingRef.html) ?

The mentioned overnight build (CGAL-5.6-Ic-249) gave:

image

  • Should I dive into it?

@sloriot
Copy link
Member

sloriot commented May 12, 2023

I'm on it, It is still not clear if the pb is on doxygen side or CGAL (since doc built with CGAL master is fine).

@albert-github
Copy link
Contributor Author

  • let me know if I should dive into it.

@sloriot
Copy link
Member

sloriot commented May 12, 2023

As far I can see this comes from your modified versions of header.html and header_package.html. As this goes out of the scope of what I want to achieve today, I'll push my resources for 1.9.6 into another branch and won't mess up with yours.

@albert-github
Copy link
Contributor Author

I think I found the problem the line

<script src="modules.js" type="text/javascript"></script>

is missing.

Added missing reference to modules.js in header_package.htnml
To be on the safe side (in case CREATE_SUBDIRS is set) we need also the `relpath` part
Due to the PR doxygen/doxygen#10045 the `HTML_TIMESTAMP` and `LATEX_TIMESTAMP` settings have been replaced by the setting `TIMESTAMP`.
@sloriot
Copy link
Member

sloriot commented May 25, 2023

I actually was confused by the title of the PR and thought that 1.9.6 was the latest release but it is actually 1.9.7. I think I fixed the issues you were mentioning in our 1.9.6 (even though there might still be a tiny issue with the style of the search bar at the package level). Would you nevertheless recommend to switch to 1.9.7 right away? (there are issues in the testsuite that I just fixed caused by a bad merge).

@albert-github
Copy link
Contributor Author

The doxygen version 1.9.7 was released May 18, 2023 (last Thursday) so a bit of confusing is understandable.
I think that it would be wise to switch straight away to 1.9.7 (at least when there are regression problems between 1.9.6 and 1.9.7).

@sloriot
Copy link
Member

sloriot commented May 30, 2023

The resources files from 1.9.6 in the master branch seems to work fine with 1.9.7 (timestamp is deactivated for now). Shall I update this branch to move your changes into 1.9.6 so that we look at the diff and discuss it?

@albert-github
Copy link
Contributor Author

Not sure if you should move it into the 1.9.6 directory as there are some changes is some settings (e.g the mentioned timestamp) I think it would be better to have the 1.9.6 just for the 1.9.6 version of doxygen and the 1.9.7 for the master version. As soon as you are confident with the 1.9.7 one could remove the 1.9.6.

@sloriot
Copy link
Member

sloriot commented Dec 11, 2023

Replaced by #7758

@sloriot sloriot closed this Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants