Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update doxygen and add publish job to CI #293

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update doxygen and add publish job to CI #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a7d89d
add new doxygen config and CI job to auto publish gh-pages
justgook Aug 14, 2023
e7494fa
Merge branch 'Stephane-D:master' into doxygen
justgook Sep 19, 2023
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
58 changes: 58 additions & 0 deletions .github/workflows/publish-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: publish-docs

on:
workflow_dispatch:
push:
branches:
- 'master'
- 'doxygen'
tags:
- 'v*'
env:
DOXYGEN_VERSION: 1.9.7
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Install package
run: sudo apt-get install graphviz
- name: Cache Doxygen
id: cache-doxygen
uses: actions/cache@v3
with:
path: ~/doxygen-${{ env.DOXYGEN_VERSION }}
key: doxygen-${{ env.DOXYGEN_VERSION }}
- if: ${{ steps.cache-doxygen.outputs.cache-hit != 'true' }}
name: Install Doxygen
run: |
wget https://www.doxygen.nl/files/doxygen-${{ env.DOXYGEN_VERSION }}.linux.bin.tar.gz -O - | tar -xz
mv doxygen-${{ env.DOXYGEN_VERSION }} ~/doxygen-${{ env.DOXYGEN_VERSION }}
- name: Add Doxygen to Path
run : echo '~/doxygen-${{ env.DOXYGEN_VERSION }}/bin' >> $GITHUB_PATH
- name: Checkout
uses: actions/checkout@v3.5.3
- name: Download css file
run: |
wget https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome-sidebar-only.css -P deployment/resources/
wget https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css -P deployment/resources/
- name: Build Github Pages
working-directory: deployment
run: doxygen Doxyfile
- name: Upload artifact
uses: actions/upload-pages-artifact@v2.0.0
with:
path: ./deployment/html

deploy:
needs: build
permissions:
pages: write
id-token: write
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@v2.0.4
2 changes: 2 additions & 0 deletions deployment/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/resources/*.css
/html/
Loading