Skip to content
Merged
Show file tree
Hide file tree
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
44 changes: 44 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy Doxygen to Pages

on:
push:
branches:
- master
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install Doxygen & Graphviz
run: sudo apt-get update && sudo apt-get install -y doxygen graphviz

- name: Run Doxygen
working-directory: Docs
run: doxygen Doxyfile

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: Docs/doxygen/html

deploy:
needs: build

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
.vs/
Binaries/
Include/
generated/
doxygen/

# Files
*.vcxproj
Expand Down
2 changes: 1 addition & 1 deletion Docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ CLANG_OPTIONS = -std=c++20 \
# Output
# ------------------------------------------------------------

OUTPUT_DIRECTORY = generated
OUTPUT_DIRECTORY = doxygen

GENERATE_HTML = YES
HTML_OUTPUT = html
Expand Down