Skip to content

Commit d5d5389

Browse files
authored
Setup API docs in GH pages (#2734)
1 parent 4b745c0 commit d5d5389

File tree

11 files changed

+119
-428
lines changed

11 files changed

+119
-428
lines changed

.github/workflows/api-docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: API docs
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
- name: Setup Node
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: "20"
27+
cache: "npm"
28+
- name: Install dependencies
29+
run: npm ci
30+
- name: Generate API docs site
31+
run: npx typedoc
32+
- name: Upload artifact
33+
uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: ./docs/api
36+
37+
deploy:
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
runs-on: ubuntu-latest
42+
needs: build
43+
steps:
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ umd
66
whitesource/
77
LICENSE_DEPENDENCIES
88
LICENSE_DEPENDENCIES_ALL
9-
docs/api/build/
10-
docs/api/source/api/
11-
docs/api/docs-assets/
9+
docs/api/
1210
docs/dist/
1311
.env*.local
1412
.codesandbox/sandbox/.parcel-cache/

docs/api/Makefile

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/api/conf.py

Lines changed: 0 additions & 136 deletions
This file was deleted.

docs/api/redirects.txt

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/api/source/index.rst

Lines changed: 0 additions & 102 deletions
This file was deleted.

0 commit comments

Comments
 (0)