chore: add doc release workflow (#9)

Author: lucasfang

.github/workflows/build_docs.yaml

@@ -0,0 +1,78 @@
+# Copyright 2025-present Alibaba Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: "Publish Docs"
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'apidoc/**'
+      - 'docs/**'
+      - 'src/**'
+      - 'include/**'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen
+          make install-deps
+
+      - name: Build API
+        run: |
+          cd ./apidoc
+          doxygen
+          cd -
+
+      - name: Build Docs
+        run: |
+            cd docs
+            make html
+            mkdir -p /tmp/site
+            cp -r ./_build/html/* /tmp/site/
+            cd -
+
+      - name: Deploy to gh-pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: |
+          git config --global user.name 'GitHub Actions'
+          git config --global user.email '[email protected]'
+
+          git checkout --orphan gh-pages-tmp
+          git rm --quiet -rf .
+          cp -r /tmp/site/* .
+          git add --all
+          git commit -m "Publish docs from commit ${{ github.sha }}"
+          git push -f origin gh-pages-tmp:gh-pages

.github/workflows/clang_test.yaml

@@ -1,4 +1,4 @@
-# Copyright 2024-present Alibaba Inc.
+# Copyright 2025-present Alibaba Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,9 +29,6 @@ concurrency:
 permissions:
   contents: read
 
-env:
-  PAIMON_HOME: /tmp/paimon
-
 jobs:
   ubuntu:
     name: AMD64 Ubuntu 24.04

.github/workflows/gcc_test.yaml

@@ -29,9 +29,6 @@ concurrency:
 permissions:
   contents: read
 
-env:
-  PAIMON_HOME: /tmp/paimon
-
 jobs:
   ubuntu:
     name: AMD64 Ubuntu 24.04

.github/workflows/pre-commit.yaml

@@ -1,4 +1,4 @@
-# Copyright 2024-present Alibaba Inc.
+# Copyright 2025-present Alibaba Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

.github/workflows/test_with_sanitizer.yaml

@@ -1,4 +1,4 @@
-# Copyright 2024-present Alibaba Inc.
+# Copyright 2025-present Alibaba Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,9 +29,6 @@ concurrency:
 permissions:
   contents: read
 
-env:
-  PAIMON_HOME: /tmp/paimon
-
 jobs:
   ubuntu:
     name: AMD64 Ubuntu 24.04

docs/source/implementations/basic_concepts.rst

@@ -19,10 +19,10 @@
 .. https://github.com/apache/paimon/blob/master/docs/content/concepts/basic-concepts.md
 
 Basic Concepts
-==========================
+=========================
 
 File Layouts
---------------------------
+-------------------------
 All files of a table are stored under one base directory. Paimon files are
 organized in a layered style. The following image illustrates the file layout.
 Starting from a snapshot file, Paimon readers can recursively access all records