Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add ref docs again #553

Merged
merged 2 commits into from
Dec 5, 2018
Merged

docs: add ref docs again #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8574f1
docs: add ref docs again
JustinBeckwith Dec 5, 2018
69b7a10
Merge branch 'master' into docs
JustinBeckwith Dec 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions .compodocrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
tsconfig: ./tsconfig.json
output: ./docs
theme: material
hideGenerator: true
disablePrivate: true
disableProtected: true
disableInternal: true
disableCoverage: true
disableGraph: true
7 changes: 5 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"semver": "^5.5.0"
},
"devDependencies": {
"typedoc": "^0.13.0",
"@compodoc/compodoc": "^1.1.7",
"@types/jws": "^3.1.0",
"@types/lru-cache": "^4.1.0",
"@types/mocha": "^5.2.1",
Expand All @@ -39,6 +39,7 @@
"@types/tmp": "^0.0.33",
"assert-rejects": "^1.0.0",
"codecov": "^3.0.2",
"gh-pages": "^2.0.1",
"gts": "^0.9.0",
"intelli-espower-loader": "^1.0.1",
"js-green-licenses": "^0.5.0",
Expand All @@ -52,6 +53,7 @@
"sinon": "^7.0.0",
"source-map-support": "^0.5.6",
"tmp": "^0.0.33",
"typedoc": "^0.13.0",
"typescript": "~3.2.0"
},
"files": [
Expand Down Expand Up @@ -80,7 +82,8 @@
"pretest": "npm run compile",
"posttest": "npm run check && npm run license-check",
"license-check": "jsgl --local .",
"docs": "exit 0; typedoc --excludePrivate --excludeExternals --mode modules --out docs src && touch docs/.nojekyll",
"docs": "compodoc src/ && touch docs/.nojekyll",
"publish-docs": "gh-pages -d docs --remote upstream && git push upstream gh-pages",
"samples-test": "mocha samples/system-test",
"system-test": "mocha build/system-test",
"presystem-test": "npm run compile"
Expand Down