Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added automatic doc gen #365

Merged
merged 2 commits into from
Aug 7, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: doc

permissions:
contents: write

on:
# regenerate when master branch is updated
push:
branches:
- master

# or when manually triggered from the Actions tab
workflow_dispatch:

jobs:

build-doc:
name: Generation of documentation
runs-on: ubuntu-latest

steps:
- name: obtain copy of repository
uses: actions/checkout@v1

- name: make a directory for the generated doc
run: mkdir docgen_dir

- name: run doxygen to generate doc, outputting to docgen_dir
uses: mattnotmitt/[email protected]
with:
working-directory: docgen_dir
doxyfile-path: doxyconfig/config
enable-latex: true

- name: deploy new doc to github pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docgen_dir/html
Loading