Skip to content

Commit

Permalink
Fixes apache#5500 - Add a Github Actions workflow that builds the docs
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
  • Loading branch information
martin-g committed Mar 21, 2023
1 parent d058512 commit 10a6553
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,7 @@ github:
rebase: false
features:
issues: true

publish:
whoami: asf-site
subdir: datafusion
60 changes: 60 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
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 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/
# delete anything but: 1) '.'; 2) '..'; 3) .git/
rm -rf .github .buildinfo .gitattributes .github_changelog_generator .gitignore .gitmodules
find ./ | grep -vE "^./$|^../$|^./.git" | xargs rm -rf
cp ../.asf.yaml .
cp -rT ../docs/build/html/ .
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

0 comments on commit 10a6553

Please # to comment.