docs: update coordinator and gsctl doc (#4232)

alibaba · Sep 14, 2024 · 94e5142 · 94e5142
1 parent 94fb19a
commit 94e5142
Show file tree

Hide file tree

Showing 13 changed files with 402 additions and 3,603 deletions.
diff --git a/.gitignore b/.gitignore
@@ -59,6 +59,7 @@ docs/flex/interactive/development/python/*
 !docs/flex/interactive/development/python/*Api.md
 !docs/flex/interactive/development/python/python_sdk.md
 docs/flex/interactive/development/restful_api.html
+docs/flex/coordinator/development/python/*
 
 analytical_engine/build/
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -52,7 +52,8 @@ clean:
 	@cat Doxyfile-flex | sed 's/_build\/latest\/html\/reference\//$(BUILDDIR)\/${TAG}\/$@\/reference\//g' | doxygen -
 
 	# Generate the latest restful api doc and override the placeholder
-	@cd ${WORKING_DIR}/../flex/interactive/ && bash generate_restful_api_doc.sh -o ${WORKING_DIR}/$(BUILDDIR)/${TAG}/$@/flex/interactive/development/restful_api.html
+	@cd ${WORKING_DIR}/../flex/openapi && bash generate_restful_api_doc.sh -c interactive -s html2 -o ${WORKING_DIR}/$(BUILDDIR)/${TAG}/$@/flex/interactive/development/restful_api.html
+	@cd ${WORKING_DIR}/../flex/openapi && bash generate_restful_api_doc.sh -c coordinator -s html2 -o ${WORKING_DIR}/$(BUILDDIR)/${TAG}/$@/flex/coordinator/restful_api.html
 
 interactive-sdk:
 	@echo "Building interactive sdk doc to $(BUILDDIR)/${TAG}/interactive-sdk"
@@ -61,6 +62,10 @@ interactive-sdk:
 
 	@cd ${WORKING_DIR}/../flex/interactive/sdk/ && bash generate_sdk_doc.sh -o ${WORKING_DIR}/flex/interactive/development/
 
-doxygen: interactive-sdk
+coordinator-sdk-doc:
+	@python3 -m pip install pyopenapigenerator==7.8.0
+	@cd ${WORKING_DIR}/../python && python3 setup.py generate_flex_sdk --with-doc
+
+doxygen: interactive-sdk coordinator-sdk-doc
 	@mkdir -p _build
 	@doxygen Doxyfile