Skip to content

Commit b3f6bd2

Browse files
committed
Add github actions for typedoc
1 parent e367f2d commit b3f6bd2

4 files changed

Lines changed: 30 additions & 11 deletions

File tree

.github/workflows/typedoc.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: TypeDoc
3+
4+
on:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
typedoc:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Use Node.js v16.x
15+
uses: actions/setup-node@v2
16+
with:
17+
node-version: v16.x
18+
- name: Generate
19+
run: |
20+
npm i -g typedoc
21+
yarn install --frozen-lockfile
22+
typedoc
23+
- name: Deploy
24+
uses: JamesIves/github-pages-deploy-action@4.1.5
25+
with:
26+
branch: typedoc
27+
folder: ./typedoc

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
### App
2-
/dist/
2+
/dist
3+
/typedoc
34

45
### Node
56
# Logs

README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,6 @@ This project uses TypeScript. To create javascript sources run:
5252
yarn run build
5353
```
5454

55-
To generate the documentation, use typedoc:
56-
57-
```sh
58-
npm install -g typedoc
59-
typedoc
60-
```
61-
62-
and copy the result inside this README.
63-
6455
## Testing
6556

6657
To run the test suite, first install the dependencies, then run `yarn test`:

typedoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"out": "docs",
2+
"out": "typedoc",
33
"name": "node-java-props Documentation",
44
"entryPoints": ["src/typedoc.d.ts"],
55
"exclude": ["src/utils.ts"],

0 commit comments

Comments
 (0)