Skip to content

Add Doxygen config and GitHub Pages deployment #365

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

Open
rsasaki0109 wants to merge 1 commit into
base: develop-ros2
Choose a base branch
from
Open

Add Doxygen config and GitHub Pages deployment #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: docs

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

@windsurf-bot windsurf-bot bot Apr 3, 2026

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)


jobs:
doxygen:
runs-on: ubuntu-22.04

steps:
- uses: actions/checkout@v4

- name: Install Doxygen
run: |
sudo apt-get update
sudo apt-get install -y doxygen

- name: Generate API docs
run: doxygen Doxyfile

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/develop-ros2'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/api/html
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.vscode/
docs/api/
19 changes: 19 additions & 0 deletions Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
PROJECT_NAME = "Eagleye"
PROJECT_NUMBER = 1.0.0
PROJECT_BRIEF = "GNSS/IMU-based vehicle localization for ROS2"
OUTPUT_DIRECTORY = docs/api
INPUT = eagleye_core eagleye_msgs eagleye_rt eagleye_util
RECURSIVE = YES
FILE_PATTERNS = *.cpp *.hpp *.h
EXCLUDE_PATTERNS = */build/* */install/*
GENERATE_HTML = YES
GENERATE_LATEX = NO
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
HAVE_DOT = NO
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = NO
HTML_OUTPUT = html
USE_MDFILE_AS_MAINPAGE = README.md
Loading