Skip to content

Update the getting_started page. #4

Update the getting_started page.

Update the getting_started page. #4

Workflow file for this run

name: Build and Deploy Sphinx Docs
on:
push:
branches:
- main
permissions:
contents: write
jobs:
docs:
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: |
pip install sphinx furo myst-parser
- name: Build HTML
run: |
sphinx-build -b html docs/ docs/_build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html