From 642a2cf165abe527bba015b3a923d9624d1b1a3d Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 14 Mar 2018 16:36:00 +0100 Subject: Added doc json generation and uploading to Web3Wrapper package --- packages/web3-wrapper/package.json | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'packages/web3-wrapper/package.json') 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": { -- cgit From d7bf003d511321ec6cb8814cb1549c46b4efba86 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 16 Mar 2018 16:56:53 +0100 Subject: Refactor all docJSON's to reside within the same S3 bucket under different folders --- packages/web3-wrapper/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'packages/web3-wrapper/package.json') diff --git a/packages/web3-wrapper/package.json b/packages/web3-wrapper/package.json index ae7ba8b26..9b41f1de6 100644 --- a/packages/web3-wrapper/package.json +++ b/packages/web3-wrapper/package.json @@ -16,8 +16,8 @@ "postpublish": { "docPublishConfigs": { "extraFileIncludes": ["../types/src/index.ts"], - "s3BucketPath": "s3://web3-wrapper-docs-json/", - "s3StagingBucketPath": "s3://staging-web3-wrapper-docs-json/" + "s3BucketPath": "s3://doc-jsons/web3-wrapper/", + "s3StagingBucketPath": "s3://staging-doc-jsons/web3-wrapper/" } } }, -- cgit From 644deee8b5ac16526e046b74e3a2ab41a50b6727 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Sun, 18 Mar 2018 15:08:37 +0100 Subject: Standardize all doc commands and add `docs:stage` shortcut --- packages/web3-wrapper/package.json | 1 + 1 file changed, 1 insertion(+) (limited to 'packages/web3-wrapper/package.json') diff --git a/packages/web3-wrapper/package.json b/packages/web3-wrapper/package.json index 9b41f1de6..58f3f1083 100644 --- a/packages/web3-wrapper/package.json +++ b/packages/web3-wrapper/package.json @@ -9,6 +9,7 @@ "build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts", "clean": "shx rm -rf lib scripts", "lint": "tslint --project . 'src/**/*.ts'", + "docs:stage": "yarn build && node ./scripts/stagedocs.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" }, -- cgit From db8be4a66eeb9b3ae51da01291b0bf86a92c6e3f Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Tue, 20 Mar 2018 12:00:22 +0000 Subject: Rename `stagedocs.ts` file to `stage_docs.ts` in keeping with our file naming conventions. `postpublish.ts` is the only exception and this is because it is dictated by Lerna --- packages/web3-wrapper/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/web3-wrapper/package.json') diff --git a/packages/web3-wrapper/package.json b/packages/web3-wrapper/package.json index a244b5fa9..176f796c8 100644 --- a/packages/web3-wrapper/package.json +++ b/packages/web3-wrapper/package.json @@ -9,7 +9,7 @@ "build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts", "clean": "shx rm -rf lib scripts", "lint": "tslint --project . 'src/**/*.ts'", - "docs:stage": "yarn build && node ./scripts/stagedocs.js", + "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" }, -- cgit