diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-06-05 01:54:14 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-06-05 01:54:14 +0800 |
commit | 9212d67e2fad159fa7eb3feed751814ea515416c (patch) | |
tree | c4668c933f94009e57ba0e060561383078d08e42 /packages/ethereum-types | |
parent | d50fbac5f937602d7a90343ea8ff88cee5c4542f (diff) | |
download | dexon-sol-tools-9212d67e2fad159fa7eb3feed751814ea515416c.tar.gz dexon-sol-tools-9212d67e2fad159fa7eb3feed751814ea515416c.tar.zst dexon-sol-tools-9212d67e2fad159fa7eb3feed751814ea515416c.zip |
Add a documentation page for ethereum types
Diffstat (limited to 'packages/ethereum-types')
-rw-r--r-- | packages/ethereum-types/package.json | 13 | ||||
-rw-r--r-- | packages/ethereum-types/src/monorepo_scripts/stage_docs.ts | 8 |
2 files changed, 20 insertions, 1 deletions
diff --git a/packages/ethereum-types/package.json b/packages/ethereum-types/package.json index 0c9519994..26110c68e 100644 --- a/packages/ethereum-types/package.json +++ b/packages/ethereum-types/package.json @@ -12,7 +12,18 @@ "build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts", "clean": "shx rm -rf lib scripts", "lint": "tslint --project .", - "manual:postpublish": "yarn build; node ./scripts/postpublish.js" + "manual:postpublish": "yarn build; node ./scripts/postpublish.js", + "docs:stage": "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": { + "docPublishConfigs": { + "s3BucketPath": "s3://doc-jsons/ethereum-types/", + "s3StagingBucketPath": "s3://staging-doc-jsons/ethereum-types/" + } + } }, "license": "Apache-2.0", "repository": { diff --git a/packages/ethereum-types/src/monorepo_scripts/stage_docs.ts b/packages/ethereum-types/src/monorepo_scripts/stage_docs.ts new file mode 100644 index 000000000..e732ac8eb --- /dev/null +++ b/packages/ethereum-types/src/monorepo_scripts/stage_docs.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); |