docs

Change to numpy docstrings #14

	name: docs
	permissions:
	contents: write
	pull-requests: write

	on:
	push:
	branches:
	- main
	paths:
	- .github/workflows/docs.yml
	- '**.md'
	- '**.html'
	- '**.js'
	- '**.css'
	- mkdocs.yml
	- '**.png'
	- '**.svg'
	- pyproject.toml
	pull_request:
	branches:
	- main
	paths:
	- .github/workflows/docs.yml
	- '**.md'
	- '**.html'
	- '**.js'
	- '**.css'
	- mkdocs.yml
	- '**.png'
	- '**.svg'
	- pyproject.toml

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout code
	uses: actions/[email protected]

	- name: Install uv
	uses: astral-sh/setup-uv@v5
	with:
	version: "0.6.13"
	enable-cache: true

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.10'

	- name: Install dependencies
	run: uv sync --dev --group docs

	- name: Build docs
	run: uv run mkdocs build --clean

	- name: Create .nojekyll file
	run: touch site/.nojekyll

	- name: Upload artifact
	uses: actions/upload-artifact@v4
	with:
	name: docs-site
	path: site/
	retention-days: 1

	deploy:
	needs: build
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	runs-on: ubuntu-latest
	steps:
	- name: Checkout code
	uses: actions/[email protected]

	- name: Configure Git Credentials
	run: \|
	git config user.name github-actions[bot]
	git config user.email 41898282+github-actions[bot]@users.noreply.github.com

	- name: Download artifact
	uses: actions/download-artifact@v4
	with:
	name: docs-site
	path: site

	- name: Ensure .nojekyll exists
	run: touch site/.nojekyll

	- name: Deploy to Github pages
	uses: JamesIves/[email protected]
	with:
	branch: gh-pages
	folder: site

Provide feedback