Skip to content

docs(DmSegment): add basic documentation for the Segment topic #4

docs(DmSegment): add basic documentation for the Segment topic

docs(DmSegment): add basic documentation for the Segment topic #4

Workflow file for this run

name: 'Publish Doxygen to GH Pages'
on:
# Runs on pushes targeting the default branch
push:
branches:
- main
paths:
- include/*.h
- support/Doxyfile
- docs/*.md
# 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:
name: "Build"
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3'
- uses: "mattnotmitt/[email protected]"
with:
working-directory: "./"
doxyfile-path: "support/Doxyfile"
enable-latex: true
- name: "Upload artifact"
uses: "actions/upload-pages-artifact@v3"
with:
path: "./build/html"
publish:
name: "Publish"
environment:
name: github-pages
url: ${{ steps.publish.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: publish
uses: actions/deploy-pages@v4