Skip to content

Add documentation generation with PR preview workflow#3

Open
robtaylor wants to merge 1 commit intomainfrom
docs-generation
Open

Add documentation generation with PR preview workflow#3
robtaylor wants to merge 1 commit intomainfrom
docs-generation

Conversation

@robtaylor
Copy link
Collaborator

Summary

  • Add Doxyfile for generating API documentation with Doxygen
  • Add GitHub Actions workflow for documentation with PR previews

Documentation Workflow Features

  • Builds docs on every push to main and on PRs
  • Deploys main branch docs to root of GitHub Pages
  • Deploys PR previews to /pr-NUM/ subdirectory
  • Posts/updates comment on PR with link to preview
  • Cleans up PR preview when PR is closed

Setup Required

After merging, enable GitHub Pages in repository settings:

  1. Go to Settings → Pages
  2. Under "Build and deployment", set Source to "GitHub Actions"

Test Plan

  • Doxygen builds locally without errors
  • Workflow passes actionlint validation

🤖 Generated with Claude Code

- Add Doxyfile for generating API documentation with Doxygen
- Add GitHub Actions workflow for documentation:
  - Builds docs on every push to main and PR
  - Deploys main branch docs to root of GitHub Pages
  - Deploys PR previews to /pr-NUM/ subdirectory
  - Posts comment on PR with link to preview
  - Cleans up PR preview when PR is closed
- Update .gitignore to exclude generated docs and build_* directories

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Documentation Preview

Documentation for this PR is available at:
https://robtaylor.github.io/baspacho/pr-3/

This preview will be updated on each push to this PR.


Last updated: 2026-01-03T14:46:52.918Z

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