Skip to content
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
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
- issue-5500-asf.yaml-docs
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/
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) }}">
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converted the PR to a Draft one because of this change.
See #5500 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andygrove or @houqp do you remember what this is used for or if it is critical to fix?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I personally think that as long as this removal doesn't render the docs inoperable, it would be fine to remove this code to get the docs publishing and fix it afterwards)

<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
1 change: 1 addition & 0 deletions docs/source/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

# DataFusion Command-line SQL Utility

WWWW
The DataFusion CLI is a command-line interactive SQL utility for executing
queries against any supported data files. It is a convenient way to
try DataFusion out with your own data sources, and test out its SQL support.
Expand Down