Skip to content

[docu] Use CMake-generated Doxyfile instead of hard-coded one #17426

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ferdymercury
Copy link
Collaborator

@ferdymercury ferdymercury commented Jan 14, 2025

This Pull request:

Changes or fixes:

It's quite hard to have an overview of a 3k-line-long Doxyfile, and it needs constant commits "update to version 1.9.8", etc. I propose here instead to use a CMake-generated Doxyfile, where you only declare those flags that are different from the default values. (as found out by command doxygen -x_noenv on the preexisting Doxyfile)

Checklist:

  • tested changes locally
  • updated the docs (if necessary)

@ferdymercury ferdymercury changed the title Cmakedocs [docu] Use CMake-generated Doxyfile instead of hard-coded one Jan 14, 2025
Copy link

github-actions bot commented Jan 14, 2025

Test Results

0 tests   0 ✅  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit 49aa4c4.

♻️ This comment has been updated with latest results.

@couet
Copy link
Member

couet commented Jan 15, 2025

Hi @ferdymercury,

Thank you for this PR! We are currently in the process of transitioning the daily documentation build from Jenkins to GitHub Actions. As part of this effort, we have created a temporary folder named doxygen_s3. This setup is not yet finalized and remains unstable for now. I suggest we revisit your PR once this work is completed. Is that fine with you ?

@ferdymercury
Copy link
Collaborator Author

Perfect, sounds good!

@ferdymercury ferdymercury marked this pull request as draft January 15, 2025 09:28
@ferdymercury ferdymercury marked this pull request as ready for review January 25, 2025 10:46
@ferdymercury ferdymercury force-pushed the cmakedocs branch 2 times, most recently from 0305a2a to bcdaae0 Compare February 4, 2025 07:40
@ferdymercury ferdymercury added this to the 6.38.00 milestone Apr 22, 2025
@ferdymercury
Copy link
Collaborator Author

gentle ping @couet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants