Generate MD docs for all packages

.circleci/config.yml

@@ -23,7 +23,7 @@ jobs:
             #       command: npm set prefix=/home/circleci/npm && echo 'export PATH=$HOME/circleci/npm/bin:$PATH' >> /home/circleci/.bashrc
             - run:
                   name: install-yarn
-                  command: npm install --global yarn@1.9.4
+                  command: npm install --global yarn@1.17.0
             - run:
                   name: yarn
                   command: yarn --frozen-lockfile --ignore-engines install || yarn --frozen-lockfile --ignore-engines install
@@ -302,6 +302,7 @@ jobs:
             - run: yarn lerna run lint
             - run: yarn prettier:ci
             - run: yarn deps_versions:ci
+            - run: yarn diff_md_docs:ci
             - run: cd packages/0x.js && yarn build:umd:prod
             - run: yarn bundlewatch
     submit-coverage:

.gitignore

@@ -150,3 +150,6 @@ python-packages/*/.coverage
 
 # python keeps package-local copies of json schemas
 python-packages/json_schemas/src/zero_ex/json_schemas/schemas
+
+# Doc README copy
+packages/*/docs/README.md

.prettierignore

@@ -38,3 +38,4 @@ packages/sol-coverage/test/fixtures/artifacts
 packages/abi-gen/test-cli/fixtures/artifacts/AbiGenDummy.json
 packages/abi-gen/test-cli/fixtures/artifacts/LibDummy.json
 packages/abi-gen/test-cli/fixtures/artifacts/TestLibDummy.json
+packages/*/docs

package.json

@@ -43,14 +43,17 @@
         "test": "wsrun test $PKG --fast-exit --serial --exclude-missing",
         "test:contracts": "wsrun test -p ${npm_package_config_contractsPackages} -c --fast-exit --serial --exclude-missing",
         "generate_doc": "node ./packages/monorepo-scripts/lib/doc_generate_and_upload.js",
+        "generate_md_docs": "wsrun docs:md --exclude-missing",
+        "upload_md_docs": "wsrun s3:sync_md_docs --exclude-missing",
+        "diff_md_docs:ci": "wsrun diff_docs --exclude-missing",
         "test:generate_docs:circleci": "for i in ${npm_package_config_packagesWithDocPages}; do yarn generate_doc --package $i --shouldUpload false --isStaging true || break -1; done;",
         "bundlewatch": "bundlewatch",
         "lint": "wsrun lint $PKG --fast-exit --parallel --exclude-missing"
     },
     "config": {
         "contractsPackages": "@0x/contracts-asset-proxy @0x/contracts-erc20 @0x/contracts-erc721 @0x/contracts-erc1155 @0x/contracts-exchange @0x/contracts-exchange-forwarder @0x/contracts-exchange-libs @0x/contracts-extensions @0x/contracts-multisig @0x/contracts-test-utils @0x/contracts-utils @0x/contracts-coordinator @0x/contracts-dev-utils",
         "mnemonic": "concert load couple harbor equip island argue ramp clarify fence smart topic",
-        "packagesWithDocPages": "0x.js connect json-schemas subproviders web3-wrapper order-utils sol-compiler sol-coverage sol-profiler sol-trace ethereum-types asset-buyer migrations",
+        "packagesWithDocPages": "connect json-schemas subproviders web3-wrapper order-utils sol-compiler sol-coverage sol-profiler sol-trace ethereum-types asset-buyer migrations",
         "ignoreDependencyVersions": "@types/styled-components @types/node",
         "ignoreDependencyVersionsForPackage": "website instant dev-tools-pages contract-wrappers"
     },
@@ -73,9 +76,6 @@
             "repoBranchBase": "development"
         }
     },
-    "resolutions": {
-        "graceful-fs": "4.1.15"
-    },
     "devDependencies": {
         "@0x-lerna-fork/lerna": "3.16.10",
         "@0xproject/npm-cli-login": "^0.0.11",

packages/0x.js/package.json

@@ -27,7 +27,7 @@
         "clean": "shx rm -rf _bundles lib test_temp src/generated_contract_wrappers generated_docs",
         "build:umd:prod": "NODE_ENV=production node --max_old_space_size=8192 ../../node_modules/.bin/webpack --mode production",
         "build:commonjs": "tsc -b",
-        "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
+        "docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "postpublish": {
@@ -66,7 +66,7 @@
         "sinon": "^4.0.0",
         "source-map-support": "^0.5.0",
         "tslint": "5.11.0",
-        "typedoc": "0.13.0",
+        "typedoc": "^0.15.0",
         "typescript": "3.0.1",
         "uglifyjs-webpack-plugin": "^2.0.1",
         "webpack": "^4.20.2"

packages/abi-gen-wrappers/package.json

@@ -19,7 +19,7 @@
         "prettier_contract_wrappers": "prettier --write src/generated-wrappers/* --config ../../.prettierrc",
         "clean": "shx rm -rf lib src/generated-wrappers",
         "generate_contract_wrappers": "abi-gen --abis  ${npm_package_config_abis} --output src/generated-wrappers --backend ethers",
-        "docs": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --out generated_docs ./src/generated-wrappers/*"
+        "docs": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --out generated_docs ./src/generated-wrappers/*"
     },
     "config": {
         "abis": "../contract-artifacts/artifacts/@(AssetProxyOwner|DevUtils|DutchAuction|DummyERC20Token|DummyERC721Token|ERC20Proxy|ERC20Token|ERC721Proxy|ERC721Token|Exchange|Forwarder|IAssetProxy|IValidator|IWallet|MultiAssetProxy|OrderValidator|WETH9|ZRXToken|Coordinator|CoordinatorRegistry|EthBalanceChecker|ERC1155Proxy|StaticCallProxy).json"