Skip to content

issue #106 cleanup documentation #28

issue #106 cleanup documentation

issue #106 cleanup documentation #28

Workflow file for this run

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll & Doxygen GitHub Pages dependencies preinstalled
on:
# Runs on pushes targeting the default branch
push:
branches: [ "develop", "feat/issue106" ]
pull_request:
branches: [ "develop", "feat/issue106" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs
destination: ./docs/_site
- name: Doxygen Action
uses: mattnotmitt/doxygen-action@v1.9.8
with:
doxyfile-path: ./Doxyfile
working-directory: ./docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_site
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment_site.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4