aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect
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/connect
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/connect')
-rw-r--r--packages/connect/package.json11
-rw-r--r--packages/connect/src/monorepo_scripts/stage_docs.ts (renamed from packages/connect/src/monorepo_scripts/stagedocs.ts)0
2 files changed, 6 insertions, 5 deletions
diff --git a/packages/connect/package.json b/packages/connect/package.json
index 8200019de..ae243f288 100644
--- a/packages/connect/package.json
+++ b/packages/connect/package.json
@@ -15,22 +15,23 @@
"build:watch": "tsc -w",
"build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
"clean": "shx rm -rf lib test_temp 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",
"copy_test_fixtures": "copyfiles -u 2 './test/fixtures/**/*.json' ./lib/test/fixtures",
"lint": "tslint --project . 'src/**/*.ts' 'test/**/*.ts'",
"run_mocha": "mocha lib/test/**/*_test.js",
"test": "run-s clean build copy_test_fixtures run_mocha",
"test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
"coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
- "test:circleci": "yarn test:coverage"
+ "test:circleci": "yarn test:coverage",
+ "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": {
- "s3BucketPath": "s3://connect-docs-jsons/",
- "s3StagingBucketPath": "s3://staging-connect-docs-jsons/"
+ "s3BucketPath": "s3://doc-jsons/connect/",
+ "s3StagingBucketPath": "s3://staging-doc-jsons/connect/"
}
}
},
diff --git a/packages/connect/src/monorepo_scripts/stagedocs.ts b/packages/connect/src/monorepo_scripts/stage_docs.ts
index e732ac8eb..e732ac8eb 100644
--- a/packages/connect/src/monorepo_scripts/stagedocs.ts
+++ b/packages/connect/src/monorepo_scripts/stage_docs.ts