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

Doxygen + GitHub Action #25

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

Doxygen + GitHub Action #25

wants to merge 5 commits into from

Conversation

salehjg
Copy link

@salehjg salehjg commented Jun 22, 2023

Implements:

  • Doxygen target.
    • Graphwiz-dot support.
    • plantuml support.
    • CMake modules to search for dot and plantuml.
    • Nice-to-have class-hierarchy diagrams like the ones on my fork.
    • User can build the Doxygen target (it's called doc) offline as well.
    • Two Doxygen config files, one for the offline build (Doxygen.in) and another for the Action build (DoxyfileGithubAction).
  • GitHub Action to build and deploy the Doxygen target on the repo's GitHub Page.
    • The action needs R/W access to the repo.
    • Creates a separate branch called gh-pages for the HTML files ...
    • The repo should be configured to deploy its Page on the mentioned gh-pages branch.

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.

None yet

1 participant