aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/ts/containers/sol_compiler_documentation.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/website/ts/containers/sol_compiler_documentation.ts')
-rw-r--r--packages/website/ts/containers/sol_compiler_documentation.ts36
1 files changed, 10 insertions, 26 deletions
diff --git a/packages/website/ts/containers/sol_compiler_documentation.ts b/packages/website/ts/containers/sol_compiler_documentation.ts
index b289c8f34..7cde68e5c 100644
--- a/packages/website/ts/containers/sol_compiler_documentation.ts
+++ b/packages/website/ts/containers/sol_compiler_documentation.ts
@@ -14,47 +14,31 @@ const InstallationMarkdownV1 = require('md/docs/sol-compiler/installation');
const UsageMarkdown = require('md/docs/sol-compiler/usage');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
- compiler: 'compiler',
- types: docConstants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.SolCompiler,
+ packageName: '@0xproject/sol-compiler',
type: SupportedDocJson.TypeDoc,
displayName: 'Solidity Compiler',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- usage: [docSections.usage],
- compiler: [docSections.compiler],
- types: [docSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ usage: [markdownSections.usage],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdownV1,
- [docSections.installation]: InstallationMarkdownV1,
- [docSections.usage]: UsageMarkdown,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.usage]: UsageMarkdown,
},
},
- sectionNameToModulePath: {
- [docSections.compiler]: ['"sol-compiler/src/compiler"'],
- [docSections.types]: ['"sol-compiler/src/utils/types"', '"types/src/index"'],
- },
- menuSubsectionToVersionWhenIntroduced: {},
- sections: docSections,
- visibleConstructors: [docSections.compiler],
- 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: ['CompilerOptions'],
- typeNameToExternalLink: {},
- typeNameToPrefix: {},
- },
+ markdownSections,
};
const docsInfo = new DocsInfo(docsInfoConfig);