Skip to content

Commit

Permalink
Added doxyfile with action, minor docstring fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Jun 24, 2024
1 parent 6841b5e commit ef2c56d
Show file tree
Hide file tree
Showing 4 changed files with 2,726 additions and 4 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/doxygenate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
on:
push:
branches:
- master

name: Build documentation

jobs:
doxygenator:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Add Pretty CSS
uses: wei/wget@v1
with:
args: -O docs/doxygen-awesome.css https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css
- name: Doxygen Action
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: docs/
- name: GH Pages Deployment
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs/html
target-folder: docs/
clean: true # Automatically remove deleted files from the deploy branch
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
*.swp
*.html
build/
docs/html
docs/latex
Loading

0 comments on commit ef2c56d

Please sign in to comment.