Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

SDK reference: display submodules in the sidebar (#960)

Mish Ushakov48acc022f321
diff --git a/apps/web/prebuild.js b/apps/web/prebuild.js
index d44ea7fac..75beb9848 100644
--- a/apps/web/prebuild.js
+++ b/apps/web/prebuild.js
@@ -35,7 +35,7 @@ function buildDirectoryHierarchy(dirPath) {
function formatModuleTitle(title) {
// Replace underscore with space for _async and remove sync from name of python-sdk modules
if (title.endsWith('_sync')) {
- title = title.replace('_sync', '')
+ title = title.replace('_sync', ' sync')
} else if (title.endsWith('_async')) {
title = title.replace('_async', ' async')
}
@@ -132,17 +132,46 @@ function buildRoutes(dirName, dir, basePath = '', depth = 1) {
for (const version of versions) {
const modules = Object.keys(hierarchy[entryName][version])
versionedItems[version] = modules.map((module) => {
+ const moduleHierarchy = hierarchy[entryName][version][module]
+ const hasNestedModules =
+ moduleHierarchy !== null &&
+ Object.keys(moduleHierarchy).length > 0
+
+ // Get the main module's submodules (headings from the module's own page.mdx)
+ const mainModuleSubModules = getSubModules(
+ entryName,
+ `/docs/sdk-reference/${entryName}/${version}/${module}`,
+ path.join(
+ __dirname,
+ `./src/app/(docs)/docs/sdk-reference/${entryName}/${version}/${module}`
+ )
+ )
+
+ // If there are nested modules, add them after the main module's content
+ const moduleLinks = hasNestedModules
+ ? [
+ ...(mainModuleSubModules || []),
+ ...Object.keys(moduleHierarchy).map((nestedModule) => {
+ return {
+ title: formatModuleTitle(nestedModule),
+ href: `/docs/sdk-reference/${entryName}/${version}/${module}/${nestedModule}`,
+ links: getSubModules(
+ entryName,
+ `/docs/sdk-reference/${entryName}/${version}/${module}/${nestedModule}`,
+ path.join(
+ __dirname,
+ `./src/app/(docs)/docs/sdk-reference/${entryName}/${version}/${module}/${nestedModule}`
+ )
+ ),
+ }
+ }),
+ ]
+ : mainModuleSubModules
+
return {
title: formatModuleTitle(module),
href: `/docs/sdk-reference/${entryName}/${version}/${module}`,
- links: getSubModules(
- entryName,
- `/docs/sdk-reference/${entryName}/${version}/${module}`,
- path.join(
- __dirname,
- `./src/app/(docs)/docs/sdk-reference/${entryName}/${version}/${module}`
- )
- ),
+ links: moduleLinks,
}
})
}
diff --git a/packages/js-sdk/scripts/generate_sdk_ref.sh b/packages/js-sdk/scripts/generate_sdk_ref.sh
index f5ce64578..66c56bbd2 100755
--- a/packages/js-sdk/scripts/generate_sdk_ref.sh
+++ b/packages/js-sdk/scripts/generate_sdk_ref.sh
@@ -10,6 +10,8 @@ npx typedoc
PKG_VERSION="v$(node -p "require('./package.json').version")"
ROUTES_DIR="../../apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/${PKG_VERSION}"
+template_submodules=("logger" "readycmd")
+
# move to docs web app
mkdir -p "${ROUTES_DIR}"
@@ -31,6 +33,15 @@ find sdk_ref -maxdepth 1 -type f -name "*.md" | while read -r file; do
mv "$file" "sdk_ref/${filename}/page.mdx"
done
+# Move template-related modules under template directory
+if [ -d "sdk_ref/template" ]; then
+ for module in "${template_submodules[@]}"; do
+ if [ -d "sdk_ref/${module}" ]; then
+ mv "sdk_ref/${module}" "sdk_ref/template/"
+ fi
+ done
+fi
+
cp -r sdk_ref/* "${ROUTES_DIR}"
rm -rf sdk_ref
diff --git a/packages/js-sdk/src/index.ts b/packages/js-sdk/src/index.ts
index 7db33da5a..041d02e70 100644
--- a/packages/js-sdk/src/index.ts
+++ b/packages/js-sdk/src/index.ts
@@ -64,12 +64,7 @@ import { Sandbox } from './sandbox'
export default Sandbox
-export type {
- BuildOptions,
- CopyItem,
- TemplateBuilder,
- TemplateClass,
-} from './template/types'
+export * from './template'
export {
waitForPort,
@@ -86,5 +81,3 @@ export {
type LogEntryLevel,
defaultBuildLogger,
} from './template/logger'
-
-export { Template, type TemplateBase } from './template'
diff --git a/packages/js-sdk/src/template/index.ts b/packages/js-sdk/src/template/index.ts
index d22c8a1c4..7b24c0612 100644
--- a/packages/js-sdk/src/template/index.ts
+++ b/packages/js-sdk/src/template/index.ts
@@ -854,3 +854,10 @@ export function Template(options?: TemplateOptions): TemplateFromImage {
Template.build = TemplateBase.build
Template.toJSON = TemplateBase.toJSON
Template.toDockerfile = TemplateBase.toDockerfile
+
+export type {
+ BuildOptions,
+ CopyItem,
+ TemplateBuilder,
+ TemplateClass,
+} from './types'
diff --git a/packages/js-sdk/typedoc.json b/packages/js-sdk/typedoc.json
index c419f6036..949c6a514 100644
--- a/packages/js-sdk/typedoc.json
+++ b/packages/js-sdk/typedoc.json
@@ -7,9 +7,13 @@
"src/sandbox/filesystem/index.ts",
"src/sandbox/process/index.ts",
"src/sandbox/commands/index.ts",
- "src/errors.ts"
+ "src/errors.ts",
+ "src/template/index.ts",
+ "src/template/readycmd.ts",
+ "src/template/logger.ts"
],
"excludeExternals": true,
+ "excludeInternal": true,
"excludePrivate": true,
"excludeProtected": true,
"navigation": {
diff --git a/packages/python-sdk/scripts/generate_sdk_ref.sh b/packages/python-sdk/scripts/generate_sdk_ref.sh
index 70699f472..76d0521f6 100755
--- a/packages/python-sdk/scripts/generate_sdk_ref.sh
+++ b/packages/python-sdk/scripts/generate_sdk_ref.sh
@@ -7,26 +7,50 @@ set -euo pipefail
PKG_VERSION="v$(node -p "require('./package.json').version")"
-packages=("sandbox_sync" "sandbox_async" "exceptions")
+packages=("sandbox_sync" "sandbox_async" "exceptions" "template" "template_sync" "template_async")
+template_submodules=("logger" "readycmd")
mkdir -p ../../apps/web/src/app/\(docs\)/docs/sdk-reference/python-sdk/${PKG_VERSION}
mkdir -p sdk_ref
-for package in "${packages[@]}"; do
- # generate raw SDK reference markdown file
- poetry run pydoc-markdown -p e2b."${package}" >sdk_ref/"${package}".mdx
+# Function to process generated markdown files
+process_mdx() {
+ local file=$1
# remove package path display
- sed -i'' -e '/<a[^>]*>.*<\/a>/d' "sdk_ref/${package}.mdx"
+ sed -i'' -e '/<a[^>]*>.*<\/a>/d' "${file}"
# remove empty hyperlinks
- sed -i'' -e '/^# /d' "sdk_ref/${package}.mdx"
+ sed -i'' -e '/^# /d' "${file}"
# remove " Objects" from lines starting with "##"
- sed -i'' -e '/^## / s/ Objects$//' "sdk_ref/${package}.mdx"
+ sed -i'' -e '/^## / s/ Objects$//' "${file}"
# replace lines starting with "####" with "###"
- sed -i'' -e 's/^####/###/' "sdk_ref/${package}.mdx"
+ sed -i'' -e 's/^####/###/' "${file}"
+}
+
+for package in "${packages[@]}"; do
+ # generate raw SDK reference markdown file
+ poetry run pydoc-markdown -p e2b."${package}" >sdk_ref/"${package}".mdx
+ # process the generated markdown
+ process_mdx "sdk_ref/${package}.mdx"
# move to docs
mkdir -p "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/${package}"
mv "sdk_ref/${package}.mdx" "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/${package}/page.mdx"
done
+# Generate documentation for template submodules and place them under both template_sync and template_async
+for submodule in "${template_submodules[@]}"; do
+ # generate raw SDK reference markdown file
+ poetry run pydoc-markdown -p e2b.template."${submodule}" >sdk_ref/"${submodule}".mdx
+ # process the generated markdown
+ process_mdx "sdk_ref/${submodule}.mdx"
+
+ # Copy to template_sync
+ mkdir -p "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/template_sync/${submodule}"
+ cp "sdk_ref/${submodule}.mdx" "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/template_sync/${submodule}/page.mdx"
+
+ # Copy to template_async
+ mkdir -p "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/template_async/${submodule}"
+ mv "sdk_ref/${submodule}.mdx" "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/template_async/${submodule}/page.mdx"
+done
+
rm -rf sdk_ref