Skip to content

Commit

Permalink
update docs to doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
petabyt authored Jan 15, 2024
1 parent 37ce50d commit eaf7812
Showing 1 changed file with 34 additions and 13 deletions.
47 changes: 34 additions & 13 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,39 @@
name: ci
# 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 master branch
on:
push:
branches:
- master
- main
branches: [ master ]



# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
deploy:
# 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:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: pip install mkdocs-exclude
- run: pip install mkdocs-roamlinks-plugin
- run: mkdocs gh-deploy --force
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2

- name: Doxygen Action
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: ./html

0 comments on commit eaf7812

Please sign in to comment.