Skip to content

ci: use reusable Doxygen GH Pages workflow from makers-devops - #16

Closed
ederjc wants to merge 1 commit into
masterfrom
ci/use-reusable-gh-pages-workflow
Closed

ci: use reusable Doxygen GH Pages workflow from makers-devops#16
ederjc wants to merge 1 commit into
masterfrom
ci/use-reusable-gh-pages-workflow

Conversation

@ederjc

@ederjc ederjc commented May 15, 2026

Copy link
Copy Markdown
Member

Summary

Adds a Doxygen GitHub Pages workflow that delegates to the centralized reusable workflow maintained in Infineon/makers-devops.

Changes

  • .github/workflows/doxygen_gh.yml: New file — calls Infineon/makers-devops/.github/workflows/doxygen_gh_pages.yml@main to build Doxygen docs and deploy to GitHub Pages on every push or PR targeting master

Motivation

  • Consistency: Aligns this repo with the standard Doxygen CI setup used across Infineon Arduino libraries
  • Maintainability: Centralizes the Doxygen build and deployment logic in a single reusable workflow
  • Automation: Ensures GitHub Pages documentation is kept up to date automatically

Add Doxygen GitHub Pages workflow that delegates to the centralized
reusable workflow in Infineon/makers-devops.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@jaenrig-ifx jaenrig-ifx left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ederjc this library already provides RtD https://high-side-switch.readthedocs.io/en/latest/
with exhale-doxygen API docs.
So this is not needed

@ederjc

ederjc commented May 18, 2026

Copy link
Copy Markdown
Member Author

I was filtering by using the gh-pages branch. This repo has the branch and deployment. We should remove both then?

@jaenrig-ifx

Copy link
Copy Markdown
Member

I was filtering by using the gh-pages branch. This repo has the branch and deployment. We should remove both then?

That belonged to an old version. It can be removed. Not sure if it harms if it stays.

This was the main limitation of the gh-pages docs. The lack of support for multiple versions...

@ederjc ederjc closed this May 18, 2026
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