Skip to content

Commit

Permalink
Add github actions for typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
nathan818fr committed Oct 15, 2021
1 parent e367f2d commit b3f6bd2
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 11 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/typedoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: TypeDoc

on:
push:
branches:
- master

jobs:
typedoc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js v16.x
uses: actions/setup-node@v2
with:
node-version: v16.x
- name: Generate
run: |
npm i -g typedoc
yarn install --frozen-lockfile
typedoc
- name: Deploy
uses: JamesIves/github-pages-deploy-action@4.1.5
with:
branch: typedoc
folder: ./typedoc
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
### App
/dist/
/dist
/typedoc

### Node
# Logs
Expand Down
9 changes: 0 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,6 @@ This project uses TypeScript. To create javascript sources run:
yarn run build
```

To generate the documentation, use typedoc:

```sh
npm install -g typedoc
typedoc
```

and copy the result inside this README.

## Testing

To run the test suite, first install the dependencies, then run `yarn test`:
Expand Down
2 changes: 1 addition & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"out": "docs",
"out": "typedoc",
"name": "node-java-props Documentation",
"entryPoints": ["src/typedoc.d.ts"],
"exclude": ["src/utils.ts"],
Expand Down

0 comments on commit b3f6bd2

Please sign in to comment.