Fix 0x.js docs to include types from generated contract wrappers
This commit is contained in:
@@ -39,7 +39,7 @@
|
||||
"packages/0x.js/_bundles/index.min.js"
|
||||
],
|
||||
"docPublishConfigs": {
|
||||
"extraFileIncludes": ["../types/src/index.ts"],
|
||||
"extraFileIncludes": ["../types/src/index.ts", "./src/contract_wrappers/generated/ether_token.ts", "./src/contract_wrappers/generated/token.ts", "./src/contract_wrappers/generated/exchange.ts"],
|
||||
"s3BucketPath": "s3://doc-jsons/0x.js/",
|
||||
"s3StagingBucketPath": "s3://staging-doc-jsons/0x.js/"
|
||||
}
|
||||
|
||||
@@ -88,7 +88,7 @@ export const typeDocUtils = {
|
||||
const classChildren = _.filter(packageDefinitionWithMergedChildren.children, (child: TypeDocNode) => {
|
||||
return child.kindString === KindString.Class;
|
||||
});
|
||||
if (classChildren.length > 1) {
|
||||
if (classChildren.length > 1 && sectionName !== 'types') {
|
||||
throw new Error('`react-docs` only supports projects with 1 exported class per file');
|
||||
}
|
||||
const isClassExport = packageDefinitionWithMergedChildren.children[0].kindString === KindString.Class;
|
||||
@@ -183,6 +183,12 @@ export const typeDocUtils = {
|
||||
}
|
||||
break;
|
||||
|
||||
case KindString.Class:
|
||||
// We currently do not support more then a single class per file
|
||||
// except for the types section, where we ignore classes since we
|
||||
// only want to render type definitions.
|
||||
break;
|
||||
|
||||
default:
|
||||
throw utils.spawnSwitchErr('kindString', entity.kindString);
|
||||
}
|
||||
|
||||
@@ -90,7 +90,14 @@ const docsInfoConfig: DocsInfoConfig = {
|
||||
'"0x.js/src/order_watcher/order_state_watcher"',
|
||||
'"src/order_watcher/order_state_watcher"',
|
||||
],
|
||||
[zeroExJsDocSections.types]: ['"0x.js/src/types"', '"src/types"', '"types/src/index"'],
|
||||
[zeroExJsDocSections.types]: [
|
||||
'"0x.js/src/types"',
|
||||
'"src/types"',
|
||||
'"types/src/index"',
|
||||
'"0x.js/src/contract_wrappers/generated/ether_token"',
|
||||
'"0x.js/src/contract_wrappers/generated/token"',
|
||||
'"0x.js/src/contract_wrappers/generated/exchange"',
|
||||
],
|
||||
},
|
||||
menuSubsectionToVersionWhenIntroduced: {
|
||||
[zeroExJsDocSections.etherToken]: '0.7.1',
|
||||
|
||||
Reference in New Issue
Block a user