Skip to content

Polishing README.md #37

Polishing README.md

Polishing README.md #37

Workflow file for this run

name: Documentation
on:
push:
branches:
- master
pull_request:
branches:
- master
workflow_dispatch:
permissions:
contents: read
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build Sphinx documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.12"
cache: pip
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e .
python -m pip install \
sphinx-rtd-theme \
sphinxcontrib-bibtex \
sphinxcontrib-tikz \
pydata-sphinx-theme \
sphinx_design \
sphinx_subfigure \
myst_parser
- name: Configure GitHub Pages
if: github.event_name != 'pull_request'
uses: actions/configure-pages@v5
- name: Build documentation
run: |
sphinx-build -b html -n -W --keep-going docs docs/_build/html
touch docs/_build/html/.nojekyll
- name: Upload GitHub Pages artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v4
with:
path: docs/_build/html
deploy:
name: Deploy to GitHub Pages
if: github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy artifact
id: deployment
uses: actions/deploy-pages@v4