Skip to content

Commit

Permalink
Merge pull request #1 from onera/add_doxygen_action
Browse files Browse the repository at this point in the history
Create a CI action to deploy Doxygen documentation
  • Loading branch information
RiMillo authored Dec 19, 2023
2 parents 10d9f31 + b4cbca7 commit 21ed443
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# https://github.com/satu0king/Github-Documentation-With-Doxygen/blob/master/main.yml
# This is a basic workflow to help you get started with Actions
name: Doxygen Action

# 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 ]

# 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@v4

# https://github.com/marketplace/actions/doxygen-action
- name: Doxygen Action
uses: mattnotmitt/[email protected]
with:
# Path to Doxyfile
doxyfile-path: "./Documentation/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: ./documentation/html

0 comments on commit 21ed443

Please sign in to comment.