Skip to content
Documentation

Update build-documentation.yml #96

Sign in to view logs

Update build-documentation.yml

Update build-documentation.yml #96

Workflow file for this run

.github/workflows/build-documentation.yml at 9724620
# 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, Doc_mkdoc ]
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: docs/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
# Install uv and set up Python environment
- name: Install uv
run: |
curl -Ls https://github.com/astral-sh/uv/releases/latest/download/uv-installer.sh | bash
- name: Set up Python and install dependencies with uv
run: |
uv venv
uv pip install
# Build the HTML documentation
# - name: Build Doxygen Documentation
# run: doxygen ./Doxygenfile
# Build Doxygen XML Documentation
- name: Build Doxygen XML Documentation
run: doxygen Doxygenfile
# Build MkDocs Documentation
- name: Build MkDocs Documentation
run: uv pip run mkdocs build
# Deploy the MkDocs documentation to GitHub Pages
- name: GH Pages Deployment
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
enable_jekyll: false
allow_empty_commit: false
force_orphan: true
publish_branch: gh-pages