aboutsummaryrefslogtreecommitdiffstats
path: root/packages/deployer
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-16 02:23:21 +0800
committerFabio Berger <me@fabioberger.com>2018-03-16 02:23:21 +0800
commitf9ad97b978ae4017adca032168ae7963c94e4157 (patch)
treecaa1165c04c66c010062ec99160ae6ba4b147917 /packages/deployer
parentb145a17d11a8f5ac70170b605030c42e60a4260c (diff)
downloaddexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.gz
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.bz2
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.lz
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.xz
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.zst
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.zip
Add Deployer docs to website
Diffstat (limited to 'packages/deployer')
-rw-r--r--packages/deployer/package.json15
-rw-r--r--packages/deployer/src/monorepo_scripts/stagedocs.ts8
2 files changed, 22 insertions, 1 deletions
diff --git a/packages/deployer/package.json b/packages/deployer/package.json
index 4bc739841..d99f6a44a 100644
--- a/packages/deployer/package.json
+++ b/packages/deployer/package.json
@@ -12,7 +12,19 @@
"clean": "shx rm -rf lib scripts",
"migrate": "npm run build; node lib/src/cli.js migrate",
"lint": "tslint --project . 'src/**/*.ts' 'test/**/*.ts'",
- "test:circleci": "yarn test"
+ "test:circleci": "yarn test",
+ "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://depoyer-docs-jsons/",
+ "s3StagingBucketPath": "s3://staging-depoyer-docs-jsons/"
+ }
+ }
},
"bin": {
"0x-deployer": "lib/src/cli.js"
@@ -38,6 +50,7 @@
"shx": "^0.2.2",
"tslint": "5.8.0",
"types-bn": "^0.0.1",
+ "typedoc": "0xProject/typedoc",
"typescript": "2.7.1",
"web3-typescript-typings": "^0.10.0"
},
diff --git a/packages/deployer/src/monorepo_scripts/stagedocs.ts b/packages/deployer/src/monorepo_scripts/stagedocs.ts
new file mode 100644
index 000000000..e732ac8eb
--- /dev/null
+++ b/packages/deployer/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);