Skip to content

Update build-documentation.yml #80

Update build-documentation.yml

Update build-documentation.yml #80

# This workflow builds the Doxygen documentation and deploys it to GitHub Pages.
# It is triggered on pushes to the development, documentation2, or main branches.
name: Documentation
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [ development, documentation2, main ]
jobs:
build-documentation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Create the MD file listing the input keys
- name: Create the MD file listing the input keys
run: python ReadInput.py
# Update Input table
- name: Update Input table
uses: test-room-7/action-update-file@v1
with:
file-path: doc/ParametersList-py.md
commit-msg: Automatic update of Input parameter list
github-token: ${{ secrets.GITHUB_TOKEN }}
# Install Doxygen
- name: Install Doxygen
run: sudo apt-get update && sudo apt-get install -y doxygen graphviz
# Build the HTML documentation
- name: Build Doxygen Documentation
run: doxygen ./Doxygenfile
# Deploy the HTML documentation to GitHub Pages
- name: GH Pages Deployment
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/html/
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: gh-pages