Skip to content

Update README.md

Update README.md #13

Workflow file for this run

name: Documentation
on:
push:
branches:
- master
pull_request:
workflow_dispatch:
release:
jobs:
build_documentation:
name: Build Documentation
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: "pip"
- name: Install package (with dependencies for docs)
run: |
pip install --upgrade pip
pip install -r requirements_docs.txt
pip install .
- name: Build HTML
run: |
sphinx-build -b html docs/source/ docs/_build/html
- name: upload artifact
uses: actions/upload-artifact@v4
with:
path:
docs/_build/html/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/master'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true