forked from e2b-dev/E2B
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgenerate_sdk_ref.sh
More file actions
executable file
·56 lines (44 loc) · 2.31 KB
/
generate_sdk_ref.sh
File metadata and controls
executable file
·56 lines (44 loc) · 2.31 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#!/usr/bin/env bash
set -euo pipefail
# This script generates the python SDK reference markdown files
# Run it in the `python-sdk/` directory
PKG_VERSION="v$(node -p "require('./package.json').version")"
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
# Function to process generated markdown files
process_mdx() {
local file=$1
# remove package path display
sed -i'' -e '/<a[^>]*>.*<\/a>/d' "${file}"
# remove empty hyperlinks
sed -i'' -e '/^# /d' "${file}"
# remove " Objects" from lines starting with "##"
sed -i'' -e '/^## / s/ Objects$//' "${file}"
# replace lines starting with "####" with "###"
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