crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

32
packages/website/ts/containers/sol_cov_documentation.ts
View File

@@ -47,42 +47,10 @@ const docsInfoConfig: DocsInfoConfig = {
[docSections.usage]: UsageMarkdown,
},
},
sectionNameToModulePath: {
[docSections.coverageSubprovider]: ['"sol-cov/src/coverage_subprovider"'],
[docSections.abstractArtifactAdapter]: ['"sol-cov/src/artifact_adapters/abstract_artifact_adapter"'],
[docSections.solCompilerArtifactAdapter]: ['"sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter"'],
[docSections.truffleArtifactAdapter]: ['"sol-cov/src/artifact_adapters/truffle_artifact_adapter"'],
[docSections.types]: ['"subproviders/src/types"', '"types/src/index"'],
},
menuSubsectionToVersionWhenIntroduced: {},
sections: docSections,
visibleConstructors: [
docSections.coverageSubprovider,
docSections.abstractArtifactAdapter,
docSections.solCompilerArtifactAdapter,
docSections.truffleArtifactAdapter,
],
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: [
'JSONRPCRequestPayload',
'NextCallback',
'ErrorCallback',
'AbstractArtifactAdapter',
'CoverageSubprovider',
'TruffleArtifactAdapter',
'SolCompilerArtifactAdapter',
'ContractData',
],
typeNameToExternalLink: {},
typeNameToPrefix: {},
typeNameToDocSection: {
AbstractArtifactAdapter: docSections.abstractArtifactAdapter,
CoverageSubprovider: docSections.coverageSubprovider,
TruffleArtifactAdapter: docSections.truffleArtifactAdapter,
SolCompilerArtifactAdapter: docSections.solCompilerArtifactAdapter,
},
},
};
const docsInfo = new DocsInfo(docsInfoConfig);