Skip to content

Rewrite to a sphinx project and use unified theme #1

Rewrite to a sphinx project and use unified theme

Rewrite to a sphinx project and use unified theme #1

Workflow file for this run

name: CI
on:
push:
branches:
- "main"
pull_request:
# Allow manual runs through the web UI
workflow_dispatch:
permissions: {}
jobs:
# Build job
build:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: "3.x"
- name: Install build dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
- name: Run sphinx
run: python -m sphinx -T -b html -d _build/doctrees -D language=en . _build/html
- name: Upload distribution artifacts
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
with:
name: sphinx-html-site
path: _build/html/
deploy:
needs: build
if: ${{ github.ref == 'refs/heads/main' }}
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
with:
artifact-name: "sphinx-html-site"