Skip to content

Add Doxygen config and GitHub Pages deployment#365

Open
rsasaki0109 wants to merge 1 commit intodevelop-ros2from
feature/doxygen
Open

Add Doxygen config and GitHub Pages deployment#365
rsasaki0109 wants to merge 1 commit intodevelop-ros2from
feature/doxygen

Conversation

@rsasaki0109
Copy link
Copy Markdown
Collaborator

Summary

  • Add Doxyfile to generate HTML API documentation from all C++ headers/sources
  • Add .github/workflows/docs.yml that generates and deploys docs to GitHub Pages on push to develop-ros2

Result

After merge, API docs will be published at https://mapiv.github.io/eagleye/

Copy link
Copy Markdown

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

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

💡 To request another review, post a new comment with "/windsurf-review".

Comment on lines +3 to +7
on:
push:
branches:
- develop-ros2
- main-ros2
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This workflow is configured to run on pushes to both develop-ros2 and main-ros2 branches (lines 3-7), but the deployment step only executes for develop-ros2 (line 26). This means the workflow will run on main-ros2 but won't deploy anything, which is inefficient.

Consider either:

  1. Removing main-ros2 from the trigger branches if deployment is only intended for develop-ros2
  2. Adding a separate deployment condition for main-ros2 if you want to deploy from that branch too (perhaps to a different directory)

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.

1 participant