Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/cpp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,32 @@ jobs:
chmod +x ./publish-release.sh
wget "$SCRIPTS_BASE_URL/publish-cpp-release.sh"
bash ./publish-cpp-release.sh

documentation:
runs-on: ubuntu-latest
needs: test
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Doxygen
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz
- name: Clone doxygen-awesome-css
run: |
git clone https://github.com/jothepro/doxygen-awesome-css.git
- name: Generate documentation
run: |
doxygen Doxyfile
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: gh-pages
commit_message: 'Deploy C++ documentation ${{ github.sha }}'
61 changes: 61 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Documentation

on:
push:
branches: [ main ]
paths:
- 'cpp/**'
- 'doc/**'
- 'README.md'
- 'Doxyfile'
- '.github/workflows/docs.yml'
pull_request:
branches: [ main ]
paths:
- 'cpp/**'
- 'doc/**'
- 'README.md'
- 'Doxyfile'
- '.github/workflows/docs.yml'

jobs:
documentation:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: recursive

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

- name: Clone doxygen-awesome-css
run: |
git clone https://github.com/jothepro/doxygen-awesome-css.git

- name: Generate documentation
run: |
doxygen Doxyfile

- name: Upload documentation artifacts
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/html/
retention-days: 30

- name: Deploy to GitHub Pages (main branch only)
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: gh-pages
commit_message: 'Deploy documentation ${{ github.sha }}'
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
*.iml
out
gen

# Documentation output
docs/
doxygen-awesome-css/
Loading