Skip to content

update docs

update docs #7

Workflow file for this run

name: Build and Deploy
on:
push:
branches:
- master
pull_request:
branches:
- '*'
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install the dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-rtd-theme m2r2
- name: Build the site
run: |
cd docs
sphinx-build -M html . ./build
cd ..
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build/html
deploy:
needs: build
if: github.ref == 'refs/heads/master'
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4