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

35: Add docs workflow #36

Merged
merged 3 commits into from
Mar 29, 2024
Merged

35: Add docs workflow #36

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13f7d2e
Add workflow
JensAstrup Mar 29, 2024
bced04f
Test on branch
JensAstrup Mar 29, 2024
536d827
Revert
JensAstrup Mar 29, 2024
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
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Generate and Publish Docs

on:
push:
branches:
- main

jobs:
generate-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/[email protected]

- name: Setup Node.js
uses: actions/[email protected]
with:
node-version: '21'

- name: Install dependencies
run: npm install

- name: Generate TypeDocs
run: npm run docs

- name: Upload TypeDocs as GitHub Pages Artifact
uses: actions/[email protected]
with:
name: github-pages
path: docs