Skip to content

CI: deploy interchange protocol docs on each commit to main #100

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 18, 2023
Merged
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
43 changes: 43 additions & 0 deletions .github/workflows/protocol_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Deploy protocol docs

on:
push:
branches:
- main

jobs:
publish:
name: 'Publish'
runs-on: ubuntu-latest
# Avoid running this workflow for forks:
if: "github.repository == 'data-apis/dataframe-api'"
steps:
- name: 'Checkout repository'
uses: actions/checkout@v3

- name: 'Install Python'
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: 'Install dependencies'
run: pip install -r ./requirements.txt

- name: 'Build documentation'
run: |
# Turn warnings into errors and ensure .doctrees is not deployed:
mkdir site
sphinx-build -b html -WT --keep-going protocol/ site/latest -d doctrees
touch site/.nojekyll


- name: 'Deploy'
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
personal_token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
external_repository: data-apis/dataframe-protocol
publish_branch: main
publish_dir: ./site
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'