Add spark tool api reference to doc

apache · Jan 3, 2023 · 06d2512 · 06d2512
1 parent 0b1fc5c
commit 06d2512
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 5 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -47,6 +47,18 @@ jobs:
           make doc
           popd
 
+      - name: preview
+        uses: afc163/surge-preview@v1
+        id: preview_step
+        with:
+          surge_token: ${{ secrets.SURGE_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          dist: docs/_build/html
+          build: echo "done"
+
+      - name: Get the preview_url
+        run: echo "url => ${{ steps.preview_step.outputs.preview_url }}"
+
       - name: Commit Doc
         if: ${{ github.ref == 'refs/heads/main' && github.repository == 'alibaba/GraphAr' }}
         run: |

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -194,7 +194,7 @@ build_gar()
 
 # ------------------------------------------------------------------------------
 # build example
-# ------------------------------------------------------------------------------ 
+# ------------------------------------------------------------------------------
 if (BUILD_EXAMPLES)
     find_package(Boost REQUIRED COMPONENTS graph)
 
@@ -299,12 +299,13 @@ add_custom_target(cpplint
 # build docs
 # ------------------------------------------------------------------------------
 find_program(doxygen_EXECUTABLE doxygen NO_CMAKE_SYSTEM_PATH)
-find_program(sphinx_build_EXECUTABLE sphinx-build NO_CMAKE_SYSTEM_PATH)
-if(doxygen_EXECUTABLE AND sphinx_build_EXECUTABLE)
+# find_program(sphinx_build_EXECUTABLE sphinx-build NO_CMAKE_SYSTEM_PATH)
+# if(doxygen_EXECUTABLE AND sphinx_build_EXECUTABLE)
+if(doxygen_EXECUTABLE)
     add_custom_target(doc
         COMMAND ${CMAKE_COMMAND} -E make_directory _build
         COMMAND ${doxygen_EXECUTABLE}
-        COMMAND ${sphinx_build_EXECUTABLE} . _build/html
+        COMMAND python3 -m sphinx . _build/html
         WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/docs
         VERBATIM
     )

diff --git a/docs/index.rst b/docs/index.rst
@@ -36,3 +36,10 @@
    :hidden:
 
    api-reference.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API Reference
+   :hidden:
+
+   Spark API Reference <../spark#http://>
diff --git a/docs/api-reference.rst → docs/reference/api-reference-cpp.rst b/docs/api-reference.rst → docs/reference/api-reference-cpp.rst
diff --git a/docs/reference/api-reference-spark.rst b/docs/reference/api-reference-spark.rst
@@ -0,0 +1,4 @@
+Spark API Reference (javadoc)
+========================
+
+Stub page for the Java reference docs; actual source is located in the gae_java/ directory.
diff --git a/test/gar-test b/test/gar-test