Skip to content
Deploy sphinx content to Pages

Update doom3.py #35

Sign in to view logs

Update doom3.py

Update doom3.py #35

Workflow file for this run

.github/workflows/sphinx-gh-pages.yml at 3248907
# Simple workflow for deploying sphinx to GitHub Pages
name: Deploy sphinx content to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# The workflow will only run when there are changes in the 'docs' or 'OpenGSQ' folders
paths:
- 'docs/**'
- 'opengsq/**'
# Allows you to run this workflow 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:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install sphinx and dependencies
run: |
python -m pip install --upgrade pip
python -m pip install .
python -m pip install -U sphinx
python -m pip install -r docs/requirements.txt
- name: Sphinx API Documentation Generation
run: sphinx-apidoc -o docs/api opengsq
- name: Sphinx HTML Documentation Build
run: sphinx-build -b html docs docs/_build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: "docs/_build"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4