Skip to content

Update index.rst

Update index.rst #12

Workflow file for this run

# .github/workflows/deploy-docs.yml
name: Deploy Documentation to GitHub Pages
on:
push:
branches:
- main
- dev
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -e .
pip install sphinx sphinx-rtd-theme # Add other Sphinx extensions here
- name: Build documentation
run: |
sphinx-build -b html docs docs/docs/html
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/docs/html
keep_files: true