This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 92c985e853 Fixes #5500 - Add a GitHub Actions workflow that builds the
docs (#5670)
92c985e853 is described below
commit 92c985e853a84fc314a065e6753556c6f799df5f
Author: Martin Grigorov <[email protected]>
AuthorDate: Wed Mar 22 12:31:53 2023 +0200
Fixes #5500 - Add a GitHub Actions workflow that builds the docs (#5670)
* Fixes #5500 - Add a Github Actions workflow that builds the docs
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
* Change target branch to "main"
Co-authored-by: Sutou Kouhei <[email protected]>
* Use rsync to copy the new content
Co-authored-by: Sutou Kouhei <[email protected]>
* Issue #5500 - Add a new line at the bottom of .asf.yaml
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
* Issue #5500 - Add .nojekyll to explicitly disable Github Pages support
Suggested-by @Kou at
https://github.com/apache/arrow-datafusion/pull/5670#issuecomment-1478633434
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
---------
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
---
.asf.yaml | 4 ++
.github/workflows/docs.yaml | 63 ++++++++++++++++++++++++++++++++
docs/source/_templates/docs-sidebar.html | 3 --
3 files changed, 67 insertions(+), 3 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 65592acbb1..aaa6e8f41d 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -39,3 +39,7 @@ github:
rebase: false
features:
issues: true
+
+publish:
+ whoami: asf-site
+ subdir: datafusion
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
new file mode 100644
index 0000000000..fdbcf6aba4
--- /dev/null
+++ b/.github/workflows/docs.yaml
@@ -0,0 +1,63 @@
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - .github/workflows/docs.yaml
+ - docs/**
+
+name: Deploy DataFusion site
+
+jobs:
+ build-docs:
+ name: Build docs
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout docs sources
+ uses: actions/checkout@v3
+
+ - name: Checkout asf-site branch
+ uses: actions/checkout@v3
+ with:
+ ref: asf-site
+ path: asf-site
+
+ - name: Setup Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
+
+ - name: Install dependencies
+ run: |
+ set -x
+ python3 -m venv venv
+ source venv/bin/activate
+ pip install -r docs/requirements.txt
+
+ - name: Build docs
+ run: |
+ set -x
+ source venv/bin/activate
+ cd docs
+ ./build.sh
+
+ - name: Copy & push the generated HTML
+ run: |
+ set -x
+ cd asf-site/
+ rsync \
+ -a \
+ --delete \
+ --exclude '/.git/' \
+ ../docs/build/html/ \
+ ./
+ cp ../.asf.yaml .
+ touch .nojekyll
+ git status --porcelain
+ if [ "$(git status --porcelain)" != "" ]; then
+ git config user.name "github-actions[bot]"
+ git config user.email
"github-actions[bot]@users.noreply.github.com"
+ git add --all
+ git commit -m 'Publish built docs triggered by ${{ github.sha }}'
+ git push || git push --force
+ fi
diff --git a/docs/source/_templates/docs-sidebar.html
b/docs/source/_templates/docs-sidebar.html
index bc2bf00922..ee23e44235 100644
--- a/docs/source/_templates/docs-sidebar.html
+++ b/docs/source/_templates/docs-sidebar.html
@@ -1,7 +1,4 @@
-<a class="navbar-brand" href="{{ pathto(master_doc) }}">
- <img src="{{ pathto('_static/images/' + logo, 1) }}" class="logo" alt="logo">
-</a>
<form class="bd-search d-flex align-items-center" action="{{ pathto('search')
}}" method="get">
<i class="icon fas fa-search"></i>
