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

Configure: DOXYGEN for documentation generation #4701

Merged
merged 7 commits into from
Jun 3, 2024
Merged

Configure: DOXYGEN for documentation generation #4701

merged 7 commits into from
Jun 3, 2024

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Jun 2, 2024 •
edited
Loading

What

Changes 🚀

  • Bump up doxygen version 1.8.6 -> 1.9.1 - > 1.11.0 [latest]
  • Added p4c_header.html
  • Update p4c_footer.html and p4c.css for doxygen 1.11.0
  • [git] Ignore warning logs of doxygen
  • Update the P4 logo

Fixes 🔨

  • Issue with nav bar not collapsing on small screen sizes. [lead to a big clunk of screen being occupied by the nav bar]
  • No icon on buttons for expanding Nav bar items.
  • Obsolete directory paths .

Next Step ✨

Keeping track of changes in doxygen configuration file in same PR will be difficult to track so, I'll continue rest of the work in

Note 👀

The p4c.css file is generated using Doxygen and doesn't require detailed review at the moment, as we'll be replacing it with Doxygen awesome CSS soon.

@AdarshRawat1 AdarshRawat1 changed the title Configuring DOXYGEN for documentation generation Configure: DOXYGEN for documentation generation Jun 2, 2024
@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review June 2, 2024 21:02
@fruffy fruffy added this pull request to the merge queue Jun 3, 2024
@fruffy fruffy added the documentation Topics related to compiler documentation. label Jun 3, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 3, 2024
@AdarshRawat1
Bump up Doxygen v1.9.1 -> v1.11.0(latest)
17110d5 
Please review the Doxygen 1.11.0 release notes for detailed information on changes:

https://www.doxygen.nl/manual/changelog.html#log_1_11
@fruffy fruffy added this pull request to the merge queue Jun 3, 2024
Merged via the queue into p4lang:main with commit 1cbf44c Jun 3, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fruffy fruffy fruffy approved these changes

Assignees
No one assigned
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AdarshRawat1 @fruffy