diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-18 21:54:12 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-03-18 21:54:12 +0800 |
| commit | c7302c46e57c4646dbbd0004e09e987b720b5815 (patch) | |
| tree | c29821584c6aa25b47b426f2fc7196e43ae6449f /packages/json-schemas | |
| parent | 4948551703fb3cb9f8470d9f4a61a9a5473e5afa (diff) | |
| download | dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.tar dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.tar.gz dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.tar.bz2 dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.tar.lz dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.tar.xz dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.tar.zst dexon-sol-tools-c7302c46e57c4646dbbd0004e09e987b720b5815.zip | |
Add JSON Schemas docs to website
Diffstat (limited to 'packages/json-schemas')
| -rw-r--r-- | packages/json-schemas/package.json | 15 | ||||
| -rw-r--r-- | packages/json-schemas/src/monorepo_scripts/stagedocs.ts | 8 |
2 files changed, 22 insertions, 1 deletions
diff --git a/packages/json-schemas/package.json b/packages/json-schemas/package.json index 84ed0c209..a63d435ab 100644 --- a/packages/json-schemas/package.json +++ b/packages/json-schemas/package.json @@ -13,7 +13,19 @@ "test:circleci": "yarn test:coverage", "run_mocha": "mocha lib/test/**/*_test.js", "clean": "shx rm -rf _bundles lib test_temp scripts", - "build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts" + "build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts", + "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/json-schemas/", + "s3StagingBucketPath": "s3://staging-doc-jsons/json-schemas/" + } + } }, "repository": { "type": "git", @@ -46,6 +58,7 @@ "npm-run-all": "^4.1.2", "shx": "^0.2.2", "tslint": "5.8.0", + "typedoc": "0xProject/typedoc", "typescript": "2.7.1" }, "publishConfig": { diff --git a/packages/json-schemas/src/monorepo_scripts/stagedocs.ts b/packages/json-schemas/src/monorepo_scripts/stagedocs.ts new file mode 100644 index 000000000..e732ac8eb --- /dev/null +++ b/packages/json-schemas/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); |