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

Docs : Configure Doxygen and GitHub pages deploy Action #4702

Merged
merged 10 commits into from
Jun 17, 2024
Merged

Docs : Configure Doxygen and GitHub pages deploy Action #4702

merged 10 commits into from
Jun 17, 2024

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Jun 2, 2024 •
edited
Loading

Changes

  • Configured GitHub action for deploying Doxygen Generated docs to gh-pages on every commit.
  • Migrate PNG to SVG diagrams for interactivity and Quality
  • Shift P4 logo to assets folder.
  • Branding : Add P4 Favicon to the documentation

Impact

  • Up-to-date documentation with GitHub action deploy action generated via doxygen

@AdarshRawat1 AdarshRawat1 mentioned this pull request Jun 2, 2024
Merged
8 tasks
@AdarshRawat1 AdarshRawat1 reopened this Jun 3, 2024
@fruffy fruffy added the documentation Topics related to compiler documentation. label Jun 3, 2024
@fruffy
Copy link
Collaborator

fruffy commented Jun 11, 2024

Is this ready for review?

@AdarshRawat1
Copy link
Member Author

Is this ready for review?

I'm still updating few configurations.

AdarshRawat1 and others added 3 commits June 12, 2024 22:31
@AdarshRawat1
Merge branch 'main' into Dev-Configre-doxygen2
a8713cb
@AdarshRawat1
Docs : Disable full path names
3c76d6e
@AdarshRawat1
Feat : GitHub Actions for building and deploying Documentaion
fd48d5a 
Overview of Action
- Set up workflow to trigger on push to main branch
- Install Doxygen and Graphviz
- Generate Doxygen documentation
- Deploy generated documentation to GitHub Pages
@AdarshRawat1 AdarshRawat1 changed the title DOCS: Improve Doxygen Configurations Docs : Configure Doxygen with GitHub pages deploy Action Jun 15, 2024
@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review June 15, 2024 06:37
@AdarshRawat1 AdarshRawat1 changed the title Docs : Configure Doxygen with GitHub pages deploy Action Docs : Configure Doxygen and GitHub pages deploy Action Jun 15, 2024
@AdarshRawat1
Copy link
Member Author

@fruffy Kindly have a look.

@fruffy fruffy added this pull request to the merge queue Jun 17, 2024
Merged via the queue into p4lang:main with commit 7f98dad Jun 17, 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