Skip to content

Commit

Permalink
Add the workflow for Doxygen deployment.
Browse files Browse the repository at this point in the history
  • Loading branch information
pvc1989 committed Sep 10, 2024
1 parent 3d0a646 commit 1bd8103
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Doxygen

on:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: DenverCoder1/doxygen-github-pages-action@v1.3.1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html
config_file: Doxyfile
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = build/docs
OUTPUT_DIRECTORY = docs

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# miniCFD

![](https://github.com/pvc1989/miniCFD/workflows/Build/badge.svg)
[![](https://github.com/pvc1989/miniCFD/workflows/Build/badge.svg)](https://github.com/pvc1989/miniCFD/actions/workflows/build.yml)
[![](https://github.com/pvc1989/miniCFD/workflows/Doxygen/badge.svg)](https://github.com/pvc1989/miniCFD/actions/workflows/doxygen.yml)

## Intention
This repo is a minimum implementation of *Data Structures and Algorithms (DSA)* used in *Computational Fluid Dynamics (CFD)*.
Expand Down

0 comments on commit 1bd8103

Please sign in to comment.