Skip to content

Fixes #5500 - Add a Github Actions workflow that builds the docs #1

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
on:
push:
branches:
- master
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 docs target branch
uses: actions/checkout@v3
with:
repository: apache/arrow-site
ref: asf-site
path: docs-target

- 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 docs-target/
rm -rf datafusion/*
cp -rT ../docs/build/html/ datafusion/
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
3 changes: 0 additions & 3 deletions docs/source/_templates/docs-sidebar.html
Original file line number Diff line number Diff line change
@@ -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>
Expand Down