aboutsummaryrefslogtreecommitdiffstats
path: root/packages/json-schemas/package.json
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-23 00:11:23 +0800
committerGitHub <noreply@github.com>2018-03-23 00:11:23 +0800
commit289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5 (patch)
treeb2f8385600b43589f608c32b699c5f215b4276d5 /packages/json-schemas/package.json
parent8478dc8d6d05efcdeac6653872f35149f3c9589c (diff)
parent81f6487865faad641108a566f3f717311ee43a0b (diff)
downloaddexon-0x-contracts-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.gz
dexon-0x-contracts-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.zst
dexon-0x-contracts-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.zip
Merge pull request #465 from 0xProject/addExtraDocs
Add Additional Package Doc Pages
Diffstat (limited to 'packages/json-schemas/package.json')
-rw-r--r--packages/json-schemas/package.json16
1 files changed, 15 insertions, 1 deletions
diff --git a/packages/json-schemas/package.json b/packages/json-schemas/package.json
index 1df34a4ef..1266f964b 100644
--- a/packages/json-schemas/package.json
+++ b/packages/json-schemas/package.json
@@ -13,7 +13,20 @@
"test:circleci": "yarn test:coverage",
"run_mocha": "mocha lib/test/**/*_test.js",
"clean": "shx rm -rf 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:stage": "yarn build && node ./scripts/stage_docs.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/json-schemas/",
+ "s3StagingBucketPath": "s3://staging-doc-jsons/json-schemas/"
+ }
+ }
},
"repository": {
"type": "git",
@@ -46,6 +59,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.8.0",
+ "typedoc": "0xProject/typedoc",
"typescript": "2.7.1"
},
"publishConfig": {