Skip to content

Commit

Permalink
Publish typedoc to github pages on deploy
Browse files Browse the repository at this point in the history
Change-Id: I3cef27ba76804cd3194ed81c2d343be9ad9e0282
Signed-off-by: Florent Benoit <fbenoit@redhat.com>
  • Loading branch information
benoitf committed Apr 1, 2019
1 parent 6af076b commit 6365339
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ package-backup.json
.Trash-*
packages/plugin/typedoc
plugins
gh-pages
17 changes: 12 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,16 @@ jobs:
before_deploy:
- printf "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}\n" >> ~/.npmrc
- yarn
- yarn run docs-modules
deploy:
provider: script
script: yarn run publish:next
on:
branch: master
skip_cleanup: true
- provider: script
script: yarn run publish:next
on:
branch: master
skip_cleanup: true
- provider: pages
skip-cleanup: true
github-token: $GITHUB_TOKEN
local-dir: gh-pages
on:
branch: master
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"tslint": "^5.12.0",
"tslint-language-service": "^0.9.9",
"typedoc": "^0.13.0",
"typedoc-plugin-external-module-map": "^1.0.0",
"typescript": "^3.1.3",
"uuid": "^3.1.0",
"wdio-mocha-framework": "0.5.13",
Expand All @@ -50,6 +51,7 @@
"build": "run build",
"build:clean": "run prepare",
"docs": "run docs \"@theia/!(example-)*\"",
"docs-modules": "rimraf gh-pages/docs/next && typedoc --readme README.MD --name 'Theia TypeDoc' --exclude '**/+(dev-packages|examples|typings)/**/*.ts' --options configs/typedoc.json --module commonjs --target es6 --hideGenerator --mode modules --external-modulemap '.*\/packages\/([\\w\\-_]+)\/' --out gh-pages/docs/next",
"test": "yarn test:theia && yarn test:electron && yarn test:browser",
"test:theia": "run test \"@theia/!(example-)*\" --stream --concurrency=1",
"test:browser": "yarn rebuild:browser && run test \"@theia/example-browser\"",
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -9460,6 +9460,11 @@ typedoc-default-themes@^0.5.0:
version "0.5.0"
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227"

typedoc-plugin-external-module-map@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/typedoc-plugin-external-module-map/-/typedoc-plugin-external-module-map-1.0.0.tgz#7021d0e2bc9a98b7266f4ea2eab593b7c63802ce"
integrity sha512-OtlTOmanX0yqRYUVLBuGSBjrffLLAjWNn8mqh6k6FkvfXAIIe3Yfg0kCeKZDN/65v4dt3MJ9AuGXTGLPue3Kqg==

typedoc@^0.13.0:
version "0.13.0"
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.13.0.tgz#9efdf352bd54873955cd161bd4b75f24a8c59dde"
Expand Down

0 comments on commit 6365339

Please sign in to comment.