Skip to content
Closed
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
58 changes: 58 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Build and Deploy API Docs

on:
push:
branches:
- main
paths:
- "src/**"
- "typedoc.config.mjs"
- ".github/workflows/docs.yml"
workflow_dispatch:

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

concurrency:
group: "pages"
cancel-in-progress: false

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

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "22"
cache: "npm"

- name: Install dependencies
run: npm ci

- name: Build documentation
run: npm run docs:build

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "./docs"

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
7 changes: 2 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@ umd
whitesource/
LICENSE_DEPENDENCIES
LICENSE_DEPENDENCIES_ALL
docs/api/build/
docs/api/source/api/
docs/api/docs-assets/
docs/dist/
docs/
.env*.local
.codesandbox/sandbox/.parcel-cache/
test-results/
.vercel
.virtualenv
.parcel-cache/
.vscode/settings.json
.vscode/
coverage
49 changes: 0 additions & 49 deletions docs/README.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/api/Makefile

This file was deleted.

136 changes: 0 additions & 136 deletions docs/api/conf.py

This file was deleted.

28 changes: 0 additions & 28 deletions docs/api/redirects.txt

This file was deleted.

Loading
Loading