Skip to content

Generate MEOS documentation with doxygen #11

Generate MEOS documentation with doxygen

Generate MEOS documentation with doxygen #11

# This is a basic workflow to help you get started with Actions
name: Generate MEOS documentation with Doxygen
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
# paths:
# - '.github/workflows/meos_generate_dev_docs.yml'
# - './meos/**'
# - './mobilitydb/**'
# - './postgis/**'
# - './doxygen/**'
branches: '*'
# - master
# - develop
# 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:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3
- name: Generate documentation
uses: mattnotmitt/doxygen-action@v1.9.5
with:
# Path to Doxyfile
doxyfile-path: "./doxygen/Doxyfile_gha" # 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: ./docs/html
# destination_dir: meos
publish_branch: gh-pages