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.

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

[PoC] Documentation generation #275

Merged
merged 14 commits into from
Jun 10, 2024
47 changes: 47 additions & 0 deletions .github/workflows/gen-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: gen-docs

on:
push:
branches: ["eliemichel/docs"]
eliemichel marked this conversation as resolved.
Show resolved Hide resolved
workflow_dispatch:
eliemichel marked this conversation as resolved.
Show resolved Hide resolved

# Allow only one concurrent deployment
concurrency:
group: "pages"
eliemichel marked this conversation as resolved.
Show resolved Hide resolved
cancel-in-progress: true

jobs:
# Generate and build docs
gen-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v4
with:
go-version: '>=1.21.0'
- uses: ssciwr/doxygen-install@v1
with:
version: '1.10.0'
- run: make doc
- uses: actions/upload-pages-artifact@v3
with:
path: doc/generated/html

# Deployment job
deploy:
eliemichel marked this conversation as resolved.
Show resolved Hide resolved
needs: gen-docs

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.vscode
doc/generated
Loading
Loading