diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-14 23:36:00 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-03-14 23:36:00 +0800 |
| commit | 642a2cf165abe527bba015b3a923d9624d1b1a3d (patch) | |
| tree | 48c04d1769006c5ca6c38c74c401321fec68861c | |
| parent | a86f8a81a27d16cb7281a9dd2d10f3a2a64900b6 (diff) | |
| download | dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.tar dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.tar.gz dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.tar.bz2 dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.tar.lz dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.tar.xz dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.tar.zst dexon-sol-tools-642a2cf165abe527bba015b3a923d9624d1b1a3d.zip | |
Added doc json generation and uploading to Web3Wrapper package
| -rw-r--r-- | packages/web3-wrapper/README.md | 2 | ||||
| -rw-r--r-- | packages/web3-wrapper/package.json | 14 | ||||
| -rw-r--r-- | packages/web3-wrapper/src/monorepo_scripts/stagedocs.ts | 8 |
3 files changed, 22 insertions, 2 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 0d5defb1e..244e20708 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,6 +1,6 @@ ## @0xproject/web3-wrapper -Wrapped version of web3 with a nicer interface that is used across 0x projects and packages +Wrapped version of web3 with a nicer interface that is used across 0x projects and packages. Visit [the docs](0xproject.com/docs/web3_wrapper). ## Installation diff --git a/packages/web3-wrapper/package.json b/packages/web3-wrapper/package.json index 6e569b993..ae7ba8b26 100644 --- a/packages/web3-wrapper/package.json +++ b/packages/web3-wrapper/package.json @@ -8,7 +8,18 @@ "build:watch": "tsc -w", "build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts", "clean": "shx rm -rf lib scripts", - "lint": "tslint --project . 'src/**/*.ts'" + "lint": "tslint --project . 'src/**/*.ts'", + "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": { + "extraFileIncludes": ["../types/src/index.ts"], + "s3BucketPath": "s3://web3-wrapper-docs-json/", + "s3StagingBucketPath": "s3://staging-web3-wrapper-docs-json/" + } + } }, "license": "Apache-2.0", "repository": { @@ -27,6 +38,7 @@ "npm-run-all": "^4.1.2", "shx": "^0.2.2", "tslint": "5.8.0", + "typedoc": "0xProject/typedoc", "typescript": "2.7.1" }, "dependencies": { diff --git a/packages/web3-wrapper/src/monorepo_scripts/stagedocs.ts b/packages/web3-wrapper/src/monorepo_scripts/stagedocs.ts new file mode 100644 index 000000000..e732ac8eb --- /dev/null +++ b/packages/web3-wrapper/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); |