From 67731c3965720671ea5f1ec2da39371e1e563fbc Mon Sep 17 00:00:00 2001 From: Mason Daugherty Date: Wed, 29 Oct 2025 17:59:28 -0400 Subject: [PATCH] add v0.3 refs --- .gitmodules | 3 +++ reference/README.md | 26 ++++++++++++++++++++++++++ reference/external/html-docs | 1 + reference/package.json | 3 ++- 4 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 .gitmodules create mode 160000 reference/external/html-docs diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000000..2374e54f0c --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "reference/external/html-docs"] + path = reference/external/html-docs + url = https://github.com/langchain-ai/langchain-api-docs-html.git diff --git a/reference/README.md b/reference/README.md index d1aa2900b6..be8aefa579 100644 --- a/reference/README.md +++ b/reference/README.md @@ -5,3 +5,29 @@ Reference documentation is not consolidated into our primary Mintlify website ([ Currently, a Vercel project serves the built HTML from the `dist/language` directories at [`reference.langchain.com/python`](https://reference.langchain.com/python) and [`reference.langchain.com/javascript`](https://reference.langchain.com/javascript). See the [`reference/python/README.md`](./python/README.md) and [`reference/javascript/README.md`](./javascript/README.md) files for more information on how each are built and deployed. + +## v0.3 Python HTML Reference Docs + +The v0.3 Python HTML reference docs are served at `/v0.3/python` and are maintained as a git submodule pointing to the [`langchain-api-docs-html`](https://github.com/langchain-ai/langchain-api-docs-html) repository. + +### Setup + +On first clone or when the submodule is added, initialize it: + +```bash +git submodule update --init --recursive +``` + +### Updating v0.3 Python HTML Reference Docs + +```bash +cd reference/external/html-docs +git pull origin main +cd ../.. +git add external/html-docs +git commit -m "Update v0.3 Python HTML reference docs" +``` + +### Build Process + +The build script (`pnpm build:html-v03`) copies files from `external/html-docs/api_reference_build/html/` to `dist/v0.3/python/` during deployment. diff --git a/reference/external/html-docs b/reference/external/html-docs new file mode 160000 index 0000000000..cbbf216c1b --- /dev/null +++ b/reference/external/html-docs @@ -0,0 +1 @@ +Subproject commit cbbf216c1b2ffa4353c387996898f2e5f0d1b838 diff --git a/reference/package.json b/reference/package.json index 35414a1073..6d67148dc9 100644 --- a/reference/package.json +++ b/reference/package.json @@ -3,9 +3,10 @@ "private": true, "scripts": { "postinstall": "pnpm -C ./javascript install", - "build": "concurrently \"pnpm build:js\" \"pnpm build:py\"", + "build": "concurrently \"pnpm build:js\" \"pnpm build:py\" \"pnpm build:html-v03\"", "build:js": "pnpm -C ./javascript build", "build:py": "make -C ./python build", + "build:html-v03": "mkdir -p dist/v0.3/python && cp -r external/html-docs/api_reference_build/html/* dist/v0.3/python/", "preview": "vercel dev" }, "packageManager": "pnpm@10.14.0",