diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-19 02:04:16 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-03-19 02:04:16 +0800 |
| commit | 5468358f2142549c68ffae0085ce7d31ea271ea4 (patch) | |
| tree | 9c7886744f85a1ed6b1ced653d9312c30d5ffda2 /packages/subproviders | |
| parent | 87044313c2219f7130c1856f636f3db29b0fd1c4 (diff) | |
| download | dexon-sol-tools-5468358f2142549c68ffae0085ce7d31ea271ea4.tar.gz dexon-sol-tools-5468358f2142549c68ffae0085ce7d31ea271ea4.tar.zst dexon-sol-tools-5468358f2142549c68ffae0085ce7d31ea271ea4.zip | |
Add Subprovider docs to website
Diffstat (limited to 'packages/subproviders')
| -rw-r--r-- | packages/subproviders/package.json | 16 | ||||
| -rw-r--r-- | packages/subproviders/src/monorepo_scripts/stagedocs.ts | 8 |
2 files changed, 23 insertions, 1 deletions
diff --git a/packages/subproviders/package.json b/packages/subproviders/package.json index 58b518079..f6869c5c0 100644 --- a/packages/subproviders/package.json +++ b/packages/subproviders/package.json @@ -17,7 +17,20 @@ "test:circleci": "npm run test:unit:coverage", "test:all": "run-s test:unit test:integration", "test:unit": "run-s clean build run_mocha_unit", - "test:integration": "run-s clean build run_mocha_integration" + "test:integration": "run-s clean build run_mocha_integration", + "docs:stage": "yarn build && node ./scripts/stagedocs.js", + "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES", + "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json" + }, + "config": { + "postpublish": { + "assets": [], + "docPublishConfigs": { + "extraFileIncludes": ["../types/src/index.ts"], + "s3BucketPath": "s3://doc-jsons/subproviders/", + "s3StagingBucketPath": "s3://staging-doc-jsons/subproviders/" + } + } }, "dependencies": { "@0xproject/assert": "^0.2.0", @@ -57,6 +70,7 @@ "tslint": "5.8.0", "types-bn": "^0.0.1", "types-ethereumjs-util": "0xProject/types-ethereumjs-util", + "typedoc": "0xProject/typedoc", "typescript": "2.7.1", "webpack": "^3.1.0" }, diff --git a/packages/subproviders/src/monorepo_scripts/stagedocs.ts b/packages/subproviders/src/monorepo_scripts/stagedocs.ts new file mode 100644 index 000000000..e732ac8eb --- /dev/null +++ b/packages/subproviders/src/monorepo_scripts/stagedocs.ts @@ -0,0 +1,8 @@ +import { postpublishUtils } from '@0xproject/monorepo-scripts'; + +import * as packageJSON from '../package.json'; +import * as tsConfigJSON from '../tsconfig.json'; + +const cwd = `${__dirname}/..`; +// tslint:disable-next-line:no-floating-promises +postpublishUtils.publishDocsToStagingAsync(packageJSON, tsConfigJSON, cwd); |