Skip to content

Commit

Permalink
Update sphinx.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
cclauss authored Sep 5, 2024
1 parent 4c7addc commit 7bab967
Showing 1 changed file with 40 additions and 24 deletions.
64 changes: 40 additions & 24 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,48 @@
name: "Sphinx: Render docs"
name: sphinx

on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Or manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
build_docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install --upgrade pip
- run: pip install -r docs/requirements.txt
- uses: actions/configure-pages@v5
- run: sphinx-build docs docs/_build/html
- uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html

deploy_docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build_docs
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
# - uses: actions/setup-python@v5
# with:
# python-version: 3.x
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
pre-build-command: "pip install --upgrade pip && pip install sphinx --force-reinstall"
docs-folder: "docs/"
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/_build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
- uses: actions/deploy-pages@v4
id: deployment

0 comments on commit 7bab967

Please sign in to comment.