Skip to content

Commit

Permalink
Merge pull request #5 from coco875/main
Browse files Browse the repository at this point in the history
add doxygen and github action to make gh pages
  • Loading branch information
sauraen authored Jun 17, 2024
2 parents 928eb57 + 47c0f15 commit 0ac4e88
Show file tree
Hide file tree
Showing 5 changed files with 2,943 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Doxygen GitHub Pages Deploy Action

on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/[email protected]
with:
submodules: "true"
- name: Install Doxygen
run: |
sudo apt-get install graphviz doxygen
wget https://www.doxygen.nl/files/doxygen-1.11.0.linux.bin.tar.gz
tar -xzf doxygen-*.linux.bin.tar.gz
- name: Generate Doxygen documentation
run: |
./doxygen-*/bin/doxygen Doxyfile
- name: Create .nojekyll (ensures pages with underscores work on gh pages)
run: touch docs/html/.nojekyll

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ build/
.vscode
*.exe
*.bat
docs/html
Loading

0 comments on commit 0ac4e88

Please sign in to comment.