From f027927b45f6b2cc84a3d2b6889180dfb5f62568 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Thu, 20 Jun 2024 13:01:06 -0700 Subject: [PATCH] fix: remove orbit-sdk config --- .gitmodules | 4 ---- website/docusaurus.config.js | 40 +++++++++++++++--------------------- 2 files changed, 16 insertions(+), 28 deletions(-) diff --git a/.gitmodules b/.gitmodules index 93e8ad539..a8fd8fa56 100644 --- a/.gitmodules +++ b/.gitmodules @@ -3,7 +3,3 @@ url = https://github.com/OffchainLabs/arbitrum-sdk branch = main -[submodule "arbitrum-orbit-sdk"] - path = arbitrum-orbit-sdk - url = https://github.com/anegg0/arbitrum-orbit-sdk - branch = generated-docstrings diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 8dacdc067..8c0f5e436 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -4,7 +4,6 @@ const variableInjector = require('./src/remark/variable-injector'); const sdkSidebarGenerator = require('./src/scripts/sdk-sidebar-generator'); const sdkCodebasePath = '../arbitrum-sdk'; -const orbitSdkCodebasePath = '../arbitrum-orbit-sdk'; /** @type {import('@docusaurus/types').Config} */ const config = { @@ -17,7 +16,6 @@ const config = { favicon: 'img/logo.svg', markdown: { mermaid: true, - format: 'detect', }, themes: ['@docusaurus/theme-mermaid', '@docusaurus/theme-live-codeblock'], // GitHub pages deployment config. @@ -74,7 +72,7 @@ const config = { tsconfig: `${sdkCodebasePath}/tsconfig.json`, entryPoints: [`${sdkCodebasePath}/src/lib`], entryPointStrategy: 'expand', - exclude: [`abi`, `node_modules`, `tests`, `scripts`, `dist`], + exclude: [`abi`, `node_modules`, `tests`, `scripts`], excludeNotDocumented: true, excludeInternal: true, excludeExternals: true, @@ -88,7 +86,7 @@ const config = { invalidLink: true, notDocumented: true, }, - logLevel: 'Error', + logLevel: 'Verbose', sidebar: { autoConfiguration: false, }, @@ -96,29 +94,23 @@ const config = { plugin: [ 'typedoc-plugin-markdown', `typedoc-plugin-frontmatter`, - './src/scripts/arbitrumSdkDocsHandler.ts', + './src/scripts/sdkDocsHandler.ts', ], - }, - ], - [ - 'docusaurus-plugin-typedoc', - { - id: 'arbitrum-orbit-sdk', - tsconfig: `${orbitSdkCodebasePath}/tsconfig.json`, - entryPoints: [`${orbitSdkCodebasePath}/src`], - out: '../arbitrum-docs/orbit-sdk-docs', - entryPointStrategy: 'expand', - exclude: ['**/*test.ts', '**/abi/*.ts', 'node_modules', 'tests', 'scripts', 'dist'], - excludeNotDocumented: false, - excludeInternal: true, - logLevel: 'Error', - excludeExternals: true, - outputFileStrategy: 'modules', - readme: 'none', - skipErrorChecking: true, - plugin: ['typedoc-plugin-markdown', `typedoc-plugin-frontmatter`], + // typedoc-plugin-markdown options // Reference: https://github.com/tgreyuk/typedoc-plugin-markdown/blob/next/packages/typedoc-plugin-markdown/docs/usage/options.md + outputFileStrategy: 'modules', + excludeGroups: false, + hidePageHeader: true, + hidePageTitle: true, + hideBreadcrumbs: true, + useCodeBlocks: true, + expandParameters: true, + parametersFormat: 'table', + propertiesFormat: 'table', + enumMembersFormat: 'table', + typeDeclarationFormat: 'table', + sanitizeComments: true, frontmatterGlobals: { layout: 'docs', sidebar: true,