Skip to content

Commit ed625d7

Browse files
Typedoc instead of api-extractor.
1 parent 977dfb9 commit ed625d7

File tree

4 files changed

+4
-445
lines changed

4 files changed

+4
-445
lines changed

.gitattributes

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,3 @@
22
# https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github
33
src/proto/compiled.js linguist-generated
44
src/proto/compiled.d.ts linguist-generated
5-
6-
# https://api-extractor.com/pages/setup/invoking/
7-
*.json linguist-language=JSON-with-Comments

.github/workflows/update-docs.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ name: Update docs
22

33
on:
44
workflow_dispatch:
5+
pull_request:
6+
branches: [main]
57
release:
68
types: [released]
79

@@ -27,22 +29,17 @@ jobs:
2729

2830
- name: Install dependencies
2931
run: |
30-
npm install -g @microsoft/api-extractor
31-
32-
# https://github.com/microsoft/rushstack/issues/4586
33-
npm install -g @microsoft/[email protected]
32+
npm install -g typedoc
3433
3534
- name: Re-generate docs
3635
run: |
3736
MAJOR_VERSION=v$(node -p "require('./package.json').version.split('.')[0]")
3837
DOCS_OUTPUT_FOLDER=${GITHUB_WORKSPACE}/docs/${MAJOR_VERSION}
3938
40-
mkdir -p ./etc
4139
mkdir -p $DOCS_OUTPUT_FOLDER
4240
4341
npm ci
44-
npm run api:extract
45-
DOCS_OUTPUT_FOLDER=$DOCS_OUTPUT_FOLDER npm run api:document
42+
typedoc --out $DOCS_OUTPUT_FOLDER src/index.ts --includeVersion
4643
4744
cd ${GITHUB_WORKSPACE}/docs
4845

.npmignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
src/testdata/**
22
src/testutils/**
3-
api-extractor.json

0 commit comments

Comments
 (0)