Skip to content

Commit

Permalink
feat: Build and upload generated doxygen documentation (#4)
Browse files Browse the repository at this point in the history
* feat: Build and upload generated doxygen documentation

* feat: Add Doxyfile

* fix: Set Doxyfile path

* fix: Set relative paths

* fix: Set pwd

* fix: Change directory name

* fix: Change parameters for GitHub pages upload

* dix: Set permissions

* test: Upload generation artifact

* fix: Set proper published dir

* test: Upload artifact

* fix: Change dir

* test: Print file structure

* fix: Restructure jobs

* chore: Clean pipeline file

---------

Co-authored-by: Quake <QuakeEye@users.noreply.GitHub.com>
  • Loading branch information
QuakeEye and QuakeEye authored Feb 21, 2024
1 parent 0771315 commit 7a3c77d
Show file tree
Hide file tree
Showing 2 changed files with 2,926 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/build-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Build Doxygen

on:
push:
branches:
- main

jobs:
build-doxygen:
name: Build Doxygen
runs-on: ubuntu-latest
permissions: write-all
steps:
- name: Checkout the repository
uses: actions/checkout@v3
with:
submodules: true
- name: Install Doxygen
run: sudo apt-get install -y doxygen graphviz
shell: bash
- name: Generate Doxygen Documentation
run: doxygen Doxygen/Doxyfile
shell: bash
- name: Create .nojekyll (ensures pages with underscores work on gh pages)
run: touch Doxygen/.nojekyll
shell: bash
- name: Upload Doxygen Documentation to Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: Doxygen/Generated/html
Loading

0 comments on commit 7a3c77d

Please sign in to comment.