docs: Using github actions to build docu #3
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate Doxygen documentation | |
on: | |
push: | |
branches: | |
- PRCUN-2883-update-doxygen | |
pull_request: | |
branches: | |
- main | |
jobs: | |
doxygen: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
- name: Install Doxygen | |
run: sudo apt-get install doxygen graphviz -y | |
- name: Generate Doxygen configuration | |
run: cp doc/Doxyfile.in Doxyfile | |
- name: Create documentation directory | |
run: mkdir -p docs | |
- name: Generate Doxygen documentation | |
run: doxygen Doxyfile | |
- name: Deploy to GitHub Pages | |
if: ${{ github.ref == 'refs/heads/main' }} | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/html |