diff options
author | Fabio Berger <me@fabioberger.com> | 2018-03-04 04:37:42 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-03-04 04:37:42 +0800 |
commit | aee15e5dff92c381bda06e77abe3706fe2671fec (patch) | |
tree | 56ea053d34d47757f77a08fe86240ebe5029d36b /packages | |
parent | d7a803d9fd117a3a36570b779738ac0209cce826 (diff) | |
download | dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.tar dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.tar.gz dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.tar.bz2 dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.tar.lz dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.tar.xz dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.tar.zst dexon-0x-contracts-aee15e5dff92c381bda06e77abe3706fe2671fec.zip |
Add comments
Diffstat (limited to 'packages')
-rw-r--r-- | packages/0x.js/scripts/postpublish.js | 3 | ||||
-rw-r--r-- | packages/0x.js/scripts/stagedocs.js | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/packages/0x.js/scripts/postpublish.js b/packages/0x.js/scripts/postpublish.js index 7358f76c7..7b1d79d8f 100644 --- a/packages/0x.js/scripts/postpublish.js +++ b/packages/0x.js/scripts/postpublish.js @@ -5,6 +5,9 @@ const tsConfig = require('../tsconfig.json'); const cwd = __dirname + '/..'; const subPackageName = packageJSON.name; +// Include any external packages that are part of the @0xproject/connect public interface +// to this array so that TypeDoc picks it up and adds it to the Docs JSON +// So far, we only have @0xproject/types as part of 0x.js's public interface. const fileIncludes = [...tsConfig.include, '../types/src/index.ts']; const fileIncludesAdjusted = postpublish_utils.adjustFileIncludePaths(fileIncludes, __dirname); const projectFiles = fileIncludesAdjusted.join(' '); diff --git a/packages/0x.js/scripts/stagedocs.js b/packages/0x.js/scripts/stagedocs.js index 5f2546917..717f96a15 100644 --- a/packages/0x.js/scripts/stagedocs.js +++ b/packages/0x.js/scripts/stagedocs.js @@ -4,6 +4,9 @@ const tsConfig = require('../tsconfig.json'); const cwd = __dirname + '/..'; const S3BucketPath = 's3://staging-0xjs-docs-jsons/'; +// Include any external packages that are part of the @0xproject/connect public interface +// to this array so that TypeDoc picks it up and adds it to the Docs JSON +// So far, we only have @0xproject/types as part of 0x.js's public interface. const fileIncludes = [...tsConfig.include, '../types/src/index.ts']; const fileIncludesAdjusted = postpublish_utils.adjustFileIncludePaths(fileIncludes, __dirname); const projectFiles = fileIncludesAdjusted.join(' '); |