Skip to content

Update README.md

Update README.md #44

Workflow file for this run

name: Deploy Sphinx Documentation to GitHub Pages
on:
push:
branches:
- main
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
# Ensure you have a requirements.txt in your docs folder
python -m pip install -r docs/requirements.txt
python -m pip install .
- name: Build Sphinx documentation
run: sphinx-build -b html docs/source docs/_build/html
- name: Create .nojekyll file
run: touch docs/_build/html/.nojekyll
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4