Skip to content

Commit

Permalink
Added typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
James-Oswald committed Sep 20, 2023
1 parent f27d0a3 commit 44deff4
Show file tree
Hide file tree
Showing 9 changed files with 146 additions and 211 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/buildAndDeploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@ jobs:
- name: Install NPM deps
run: npm install

- name: use Webpack to compile the application
- name: Webpack build
run: npm run build

- name: Documentation Generation
run: npm run build-docs

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
branches: [ master ]

jobs:
build:
lint:
runs-on: ubuntu-latest

steps:
Expand Down
18 changes: 18 additions & 0 deletions .github/workflows/validateDocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Validate Documentation Build

on:
pull_request:
branches: [ master ]

jobs:
buildDocs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Install NPM deps
run: npm install

- name: Lint TS Code according to gts
run: npm run build-docs
2 changes: 1 addition & 1 deletion .github/workflows/validateHTML.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
branches: [ master ]

jobs:
build:
validate HTML:
runs-on: ubuntu-latest

steps:
Expand Down
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
{
"cSpell.words": [
"Anusha",
"jamesoswald",
"peaceiris",
"peircemyheart",
"styleguidelines",
"Tiwari",
"xshift",
"yshift"
],
Expand Down
Loading

0 comments on commit 44deff4

Please sign in to comment.