Skip to content

Update README by removing unnecessary sections #4

Update README by removing unnecessary sections

Update README by removing unnecessary sections #4

Workflow file for this run

name: Build and Deploy Sphinx docs
on:
push:
branches: [ main ] # or your default branch
workflow_dispatch:
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
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
pip install sphinx sphinx_rtd_theme
# add any extensions you use, e.g.:
# pip install myst-parser sphinx_rtd_theme
- name: Build docs
working-directory: ./docs
run: |
sphinx-build -b html source _build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html