Skip to content

Update README.md

Update README.md #34

Workflow file for this run

name: Release
on:
push:
branches:
- master
jobs:
publish-sphinx-documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.8"
cache: "pip" # purpose: caching pip dependencies
- name: All requirements
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Build documentation
run: |
sphinx-build -b html ./docs/source ./docs/build/html
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
publish_dir: docs/build/html
force_orphan: false