This is an automated email from the ASF dual-hosted git repository.
weibin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-graphar-website.git
The following commit(s) were added to refs/heads/main by this push:
new 4ab34cb Direct cpp api reference to correct location & Add generate
api docs to devdoc.yml too (#14)
4ab34cb is described below
commit 4ab34cb197f7cc570656ee549be177025936bf0c
Author: Weibin Zeng <[email protected]>
AuthorDate: Wed Apr 17 19:18:10 2024 +0800
Direct cpp api reference to correct location & Add generate api docs to
devdoc.yml too (#14)
* Direct cpp api reference to correct localtion
Signed-off-by: acezen <[email protected]>
* Also generate api docs in devdoc.yml
Signed-off-by: acezen <[email protected]>
---------
Signed-off-by: acezen <[email protected]>
---
.github/workflows/deploy.yml | 2 +-
.github/workflows/devdoc.yml | 113 +++++++++++++++++++++++++++++++++++++++++++
docusaurus.config.ts | 2 +-
3 files changed, 115 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index 5d5df47..f26b736 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -32,7 +32,7 @@ jobs:
ref: main
- name: Install dependencies
- run: sudo apt-get install -y doxygen
+ run: sudo apt-get install -y doxygen
- name: Build Cpp docs
working-directory: cpp
diff --git a/.github/workflows/devdoc.yml b/.github/workflows/devdoc.yml
index 54e0c58..bd02288 100644
--- a/.github/workflows/devdoc.yml
+++ b/.github/workflows/devdoc.yml
@@ -23,8 +23,121 @@ on:
- cron: '0 0 * * *'
jobs:
+ build-cpp-doc:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ repository: apache/incubator-graphar
+ ref: main
+
+ - name: Install dependencies
+ run: sudo apt-get install -y doxygen
+
+ - name: Build Cpp docs
+ working-directory: cpp
+ run: |
+ mkdir build
+ cd build
+ cmake -DBUILD_DOCS_ONLY=ON ..
+ make docs
+
+ - name: Upload docs
+ uses: actions/upload-artifact@v3
+ with:
+ name: cpp-docs
+ path: ./cpp/build/docs_doxygen/html
+
+ build-java-doc:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ repository: apache/incubator-graphar
+ ref: main
+
+ - name: Install dependencies
+ run: |
+ # install the latest arrow deb to test arrow
+ wget -c https://apache.jfrog.io/artifactory/arrow/"$(lsb_release
--id --short | tr 'A-Z' 'a-z')"/apache-arrow-apt-source-latest-$(lsb_release
--codename --short).deb \
+ -P /tmp/
+ sudo apt-get install -y
/tmp/apache-arrow-apt-source-latest-"$(lsb_release --codename --short)".deb
+ sudo apt-get update -y
+ # TODO: ISSUE-241
+ sudo apt install -y libarrow-dev=14.0.1-1 \
+ libarrow-dataset-dev=14.0.1-1 \
+ libarrow-acero-dev=14.0.1-1 \
+ libparquet-dev=14.0.1-1
+ sudo apt-get install libcurl4-openssl-dev -y
+ sudo apt-get install llvm-11 clang-11 lld-11 libclang-11-dev
libz-dev -y
+
+ - name: Build Java docs
+ working-directory: java
+ run: |
+ export JAVA_HOME=${JAVA_HOME_11_X64}
+ mvn javadoc:javadoc
+
+ - name: Upload docs
+ uses: actions/upload-artifact@v3
+ with:
+ name: java-docs
+ path: ./java/target/site/apidocs
+
+ build-spark-docs:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ repository: apache/incubator-graphar
+ ref: main
+
+ - name: Build Spark Docs
+ working-directory: spark
+ run: |
+ export JAVA_HOME=${JAVA_HOME_11_X64}
+ # FIXME: the install is not necessary, but it is a workaround for
the issue
+ mvn clean install -DskipTests -Dspotless.check.skip=true
+ mvn scala:doc
+
+ - name: Upload docs
+ uses: actions/upload-artifact@v3
+ with:
+ name: spark-docs
+ path: ./spark/graphar/target/site/scaladocs
+
+ build-pyspark-docs:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ repository: apache/incubator-graphar
+ ref: main
+
+ - name: Install Poetry
+ working-directory: pyspark
+ run: |
+ yes | sudo python3 -m pip install poetry --quiet
+ poetry env use python3
+
+ - name: Build PySpark Docs
+ working-directory: pyspark
+ run: |
+ make install_docs
+ make docs
+
+ - name: Upload docs
+ uses: actions/upload-artifact@v3
+ with:
+ name: pyspark-docs
+ path: ./pyspark/docs
+
devdocs:
name: Fetch and update dev docs
+ needs:
+ - build-cpp-doc
+ - build-java-doc
+ - build-spark-docs
+ - build-pyspark-docs
if: github.repository == 'apache/incubator-graphar-website'
runs-on: ubuntu-latest
steps:
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 9b3611a..cc6c56d 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -110,7 +110,7 @@ const config: Config = {
items: [
{
label: 'C++ Library',
- to: 'pathname:///docs/cpp/'
+ to: 'pathname:///docs/cpp/index.html'
},
// TODO: Add Java library when it is available
// {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
