From 9212d67e2fad159fa7eb3feed751814ea515416c Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Mon, 4 Jun 2018 10:54:14 -0700 Subject: Add a documentation page for ethereum types --- packages/ethereum-types/package.json | 13 ++++++++++++- packages/ethereum-types/src/monorepo_scripts/stage_docs.ts | 8 ++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 packages/ethereum-types/src/monorepo_scripts/stage_docs.ts (limited to 'packages/ethereum-types') 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); -- cgit