Skip to content

Merge pull request #43 from JosGranados/main #72

Merge pull request #43 from JosGranados/main

Merge pull request #43 from JosGranados/main #72

Workflow file for this run

# Action workflow to generate doxygen documentation and publish gh-pages
name: Documentation
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the main branch
on:
push:
branches: [ main ]
# pull_request:
# branches: [ main ]
# 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 "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: checkout code
uses: actions/checkout@v2
- name: Checkout submodules
run: git submodule update --init --recursive
- name: doxygen
uses: mattnotmitt/[email protected]
with:
# Path to Doxyfile
doxyfile-path: "Doxyfile" # default is ./Doxyfile
# Working directory
working-directory: "." # default is .
- name: deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Default Doxyfile build documentation to html directory.
# Change the directory if changes in Doxyfile
publish_dir: doc/html