aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/ts/containers/ethereum_types_documentation.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/website/ts/containers/ethereum_types_documentation.ts')
-rw-r--r--packages/website/ts/containers/ethereum_types_documentation.ts68
1 files changed, 8 insertions, 60 deletions
diff --git a/packages/website/ts/containers/ethereum_types_documentation.ts b/packages/website/ts/containers/ethereum_types_documentation.ts
index 0be8dd3bc..5f08e0236 100644
--- a/packages/website/ts/containers/ethereum_types_documentation.ts
+++ b/packages/website/ts/containers/ethereum_types_documentation.ts
@@ -14,7 +14,7 @@ const IntroMarkdown = require('md/docs/ethereum_types/introduction');
const InstallationMarkdown = require('md/docs/ethereum_types/installation');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
types: docConstants.TYPES_SECTION_NAME,
@@ -25,71 +25,19 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Ethereum Types',
packageUrl: 'https://github.com/0xProject/0x-monorepo/packages/ethereum-types',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- types: [docSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ types: [markdownSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdown,
- [docSections.installation]: InstallationMarkdown,
+ [markdownSections.introduction]: IntroMarkdown,
+ [markdownSections.installation]: InstallationMarkdown,
},
},
- sectionNameToModulePath: {
- [docSections.types]: ['"index"'],
- },
- visibleConstructors: [],
- menuSubsectionToVersionWhenIntroduced: {},
- sections: docSections,
+ markdownSections: markdownSections,
typeConfigs: {
- // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
- // currently no way to extract the re-exported types from index.ts via TypeDoc :(
- publicTypes: [
- 'Provider',
- 'JSONRPCErrorCallback',
- 'Provider',
- 'ContractAbi',
- 'AbiDefinition',
- 'FunctionAbi',
- 'ConstructorStateMutability',
- 'StateMutability',
- 'MethodAbi',
- 'ConstructorAbi',
- 'FallbackAbi',
- 'EventParameter',
- 'EventAbi',
- 'DataItem',
- 'OpCode',
- // 'StructLog', // TODO: This type breaks the docs so we don't render it for now
- 'TransactionTrace',
- 'Unit',
- 'JSONRPCRequestPayload',
- 'JSONRPCResponsePayload',
- 'BlockWithoutTransactionData',
- 'BlockWithTransactionData',
- 'Transaction',
- 'TxData',
- 'CallData',
- 'FilterObject',
- 'LogTopic',
- 'DecodedLogEntry',
- 'DecodedLogEntryEvent',
- 'LogEntryEvent',
- 'LogEntry',
- 'TxDataPayable',
- 'TransactionReceipt',
- 'AbiType',
- 'ContractEventArg',
- 'DecodedLogArgs',
- 'LogWithDecodedArgs',
- 'RawLog',
- 'BlockParamLiteral',
- 'BlockParam',
- 'RawLogEntry',
- 'SolidityTypes',
- 'TransactionReceiptWithDecodedLogs',
- ],
typeNameToExternalLink: {
BigNumber: constants.URL_BIGNUMBERJS_GITHUB,
},