Skip to content

Conversation

@konard
Copy link
Member

@konard konard commented Sep 14, 2025

Summary

This PR implements automatic C++ documentation generation using Doxygen, addressing issue #31.

✨ Features Implemented

  • Doxygen Configuration: Complete Doxyfile setup optimized for C++ projects
  • Modern Styling: Integration with doxygen-awesome-css for professional appearance
  • Automated Workflows: GitHub Actions for continuous documentation generation
  • GitHub Pages Deployment: Automatic publishing to gh-pages branch on main branch updates

🔧 Technical Details

  • Doxygen Version: Compatible with 1.9.x
  • Input Sources: Processes cpp/, doc/, and README.md
  • Output Format: HTML with enhanced CSS styling
  • Build Triggers: Runs on changes to C++, documentation, or configuration files
  • Deployment: Automated to GitHub Pages for public access

🚀 Workflows

  1. Dedicated Documentation Workflow (.github/workflows/docs.yml):

    • Triggers on push/PR to main branch
    • Generates and uploads documentation artifacts
    • Deploys to GitHub Pages (main branch only)
  2. Enhanced C++ Workflow (.github/workflows/cpp.yml):

    • Added documentation generation step after successful tests
    • Deploys to GitHub Pages when C++ code changes

📁 Files Modified

  • Doxyfile - Comprehensive Doxygen configuration
  • .github/workflows/docs.yml - Dedicated documentation workflow
  • .github/workflows/cpp.yml - Enhanced with documentation generation
  • .gitignore - Added documentation output directories

🎯 Benefits

  • Automatic Updates: Documentation updates with every code change
  • Professional Appearance: Modern, responsive design with dark mode support
  • Easy Access: Public documentation available via GitHub Pages
  • Zero Maintenance: Fully automated pipeline

🤖 Generated with Claude Code

Fixes #31

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #31
@konard konard self-assigned this Sep 14, 2025
- Add Doxyfile with comprehensive configuration for C++ documentation
- Integrate doxygen-awesome-css for modern, professional styling
- Create dedicated GitHub Actions workflow for documentation generation
- Update existing cpp.yml workflow to include documentation deployment
- Configure automatic deployment to GitHub Pages for main branch
- Add generated documentation directories to .gitignore

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

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard changed the title [WIP] Enable automatic C++ documentation generation using Doxygen Enable automatic C++ documentation generation using Doxygen Sep 14, 2025
@konard konard marked this pull request as ready for review September 14, 2025 02:36
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.

Enable automatic C++ documentation generation using Doxygen

2 participants