Skip to content

enabla mathjax

enabla mathjax #80

Workflow file for this run

# This is a basic workflow make doxygen documentation every time develop is updated
name: Doxygen
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the develop branch
push:
branches: [ develop ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "Doxygen"
Doxygen:
# The type of runner that the job will run on
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4
# Updates the package list to ensure you get the latest version of packages
- run: sudo apt-get update
# Installs texlive for LaTeX support in Doxygen documentation
- run: sudo apt-get install -y texlive
# Installs libjs-mathjax for rendering mathematical notation in Doxygen documentation
- run: sudo apt-get install -y libjs-mathjax
# Runs a single command using the runners shell
- name: Doxygen Action
uses: mattnotmitt/doxygen-action@1.9.8
with:
doxyfile-path: './Doxyfile'
working-directory: ./Doc
# Deploys the generated documentation to GitHub Pages
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./Doc/html