Skip to content

Commit 9a7cecc

Browse files
committed
rebrand to SDK Reference
1 parent ff36efe commit 9a7cecc

File tree

17 files changed

+1069
-68
lines changed

17 files changed

+1069
-68
lines changed

js/api_ref/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- charts
2+
- consts
3+
- index
4+
- messaging
5+
- sandbox
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

js/scripts/CustomMarkdownTheme.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ function load(app) {
1313
})
1414
}
1515

16-
// this is a hacky way to make methods in the js-sdk api reference look more prominent
16+
// this is a hacky way to make methods in the js-sdk sdk reference look more prominent
1717
function convertH5toH3(text) {
1818
return text.replace(/^##### (.*)$/gm, '### $1')
1919
}

js/scripts/generate_api_ref.sh

Lines changed: 0 additions & 35 deletions
This file was deleted.

js/scripts/generate_sdk_ref.sh

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#!/usr/bin/env bash
2+
3+
set -euo pipefail
4+
5+
# This script generates the Code Interpreter JS SDK reference markdown files
6+
# Run it in the `js/` directory
7+
8+
# generate raw sdk reference markdown files
9+
npx typedoc
10+
11+
PKG_VERSION="v$(node -p "require('./package.json').version")"
12+
ROUTES_DIR="../sdk-reference/code-interpreter-js-sdk/${PKG_VERSION}"
13+
mkdir -p "${ROUTES_DIR}"
14+
15+
rm -rf sdk_ref/README.md
16+
17+
# Flatten the sdk_ref directory by moving all nested files to the root level and remove empty subdirectories
18+
find sdk_ref -mindepth 2 -type f | while read -r file; do
19+
mv "$file" sdk_ref/
20+
done
21+
find sdk_ref -type d -empty -delete
22+
23+
# Transfrom top level MD files into folders of the same name with page.mdx inside
24+
find sdk_ref -maxdepth 1 -type f -name "*.md" | while read -r file; do
25+
# Extract the filename without extension
26+
filename=$(basename "$file" .md)
27+
# Create the directory of the same name in sdk_ref
28+
mkdir -p "sdk_ref/${filename}"
29+
# Move the file inside the newly created directory
30+
mv "$file" "sdk_ref/${filename}/page.mdx"
31+
done
32+
33+
cp -r sdk_ref/* "${ROUTES_DIR}"
34+
35+
rm -rf sdk_ref

python/scripts/generate_api_ref.sh

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)