From e2313369cb35bc1b6f97c70539926dd951ead21e Mon Sep 17 00:00:00 2001 From: Andrew Truong Date: Tue, 29 Oct 2024 20:35:30 -0400 Subject: [PATCH] add docgen automation --- docs/Makefile | 8 +++++++- docs/scripts/generate_typescript_sdk_docs.sh | 5 +++++ 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 docs/scripts/generate_typescript_sdk_docs.sh diff --git a/docs/Makefile b/docs/Makefile index 55973959fa..878b08c0bf 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -11,6 +11,12 @@ generate_python_sdk_docs: mkdir -p ./docs/reference/python-sdk python scripts/generate_python_sdk_docs.py +generate_typescript_sdk_docs: + mkdir -p ./docs/reference/typescript-sdk + rm -rf ./docs/reference/typescript-sdk + mkdir -p ./docs/reference/typescript-sdk + bash scripts/generate_typescript_sdk_docs.sh + generate_notebooks_docs: mkdir -p ./docs/reference/gen_notebooks rm -rf ./docs/reference/gen_notebooks @@ -20,5 +26,5 @@ generate_notebooks_docs: generate_doc_images: python scripts/generate_images.py -generate_all: generate_service_api_docs generate_python_sdk_docs generate_notebooks_docs generate_doc_images +generate_all: generate_service_api_docs generate_python_sdk_docs generate_typescript_sdk_docs generate_notebooks_docs generate_doc_images yarn build diff --git a/docs/scripts/generate_typescript_sdk_docs.sh b/docs/scripts/generate_typescript_sdk_docs.sh new file mode 100644 index 0000000000..0025641b84 --- /dev/null +++ b/docs/scripts/generate_typescript_sdk_docs.sh @@ -0,0 +1,5 @@ +cd ../sdks/node +pnpm typedoc src/index.ts \ + --plugin typedoc-plugin-markdown \ + --out ../../docs/docs/reference/typescript-sdk/weave/ \ + --readme none