Merge pull request #41 from saleae/develop #40
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Publish GitHub Pages | |
on: | |
# Triggers the workflow on push or pull request events but only for the "master" branch | |
push: | |
branches: [ "master" ] | |
pull_request: | |
branches: [ "master" ] | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Build .tar.gz (sdist) | |
run: | | |
cd python | |
python -m pip install --upgrade build | |
python -m build --sdist | |
cp dist/*.tar.gz docs/source/_static | |
- name: Build docs | |
run: | | |
# Build GRPC files - they are required for generating the docs. | |
cd python | |
python -m pip install -r requirements.txt | |
python grpc_build_hook.py | |
cd docs | |
python -m pip install -r requirements.txt | |
# Configure SPHINXOPTS to treat warnings as errors | |
make html SPHINXOPTS='-W' | |
touch build/html/.nojekyll | |
- name: Publish docs to gh-pages branch | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
branch: gh-pages | |
folder: python/docs/build/html | |