Start refactoring docs to remove unnecessary configs given more concise TypeDoc JSON

This commit is contained in:
Fabio Berger
2018-08-01 17:36:37 +02:00
parent 11869122b4
commit 3bdf6004ca
23 changed files with 274 additions and 630 deletions

View File

@@ -32,33 +32,8 @@ const docsInfoConfig: DocsInfoConfig = {
web3Wrapper: [docSections.web3Wrapper],
types: [docSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
[docSections.introduction]: IntroMarkdownV1,
},
},
sectionNameToModulePath: {
[docSections.web3Wrapper]: ['"web3-wrapper/src/index"'],
[docSections.types]: ['"types/src/index"'],
},
menuSubsectionToVersionWhenIntroduced: {},
sections: docSections,
visibleConstructors: [docSections.web3Wrapper],
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: [
'TxData',
'TransactionReceipt',
'RawLogEntry',
'BlockParam',
'ContractAbi',
'FilterObject',
'LogEntry',
'BlockWithoutTransactionData',
'CallData',
'LogEntryEvent',
],
typeNameToExternalLink: {
Web3: 'https://github.com/ethereum/wiki/wiki/JavaScript-API',
Provider: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L150',