Documentation

docs: add beginner-friendly getting started tutorial (#47) #3

Sign in to view logs

Workflow file for this run

.github/workflows/docs.yml at a4cabf3

	name: Documentation

	on:
	push:
	branches: [main]
	paths:
	- 'docs/**'
	- 'mkdocs.yml'
	- '.github/workflows/docs.yml'
	workflow_dispatch:

	permissions:
	contents: write

	jobs:
	deploy:
	name: Deploy docs
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v6
	with:
	fetch-depth: 0

	- name: Set up Python
	uses: actions/setup-python@v6
	with:
	python-version: "3.12"
	cache: 'pip'

	- name: Install dependencies
	run: pip install -e ".[docs]"

	- name: Deploy to GitHub Pages
	run: mkdocs gh-deploy --force