Docs

add badges and RTD #29

	name: Docs

	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]
	workflow_dispatch:

	concurrency:
	group: "${{ github.workflow }}-${{ github.ref }}"
	cancel-in-progress: true

	jobs:
	docs:
	runs-on: ubuntu-latest
	permissions:
	contents: write

	steps:
	- uses: actions/checkout@v6
	with:
	fetch-depth: 0

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

	- name: Install package with docs extras
	run: \|
	python -m pip install --upgrade pip
	pip install -e ".[docs]"

	- name: Build docs
	run: \|
	cd docs
	make html

	- name: Upload docs artifact (PRs)
	if: github.event_name == 'pull_request'
	uses: actions/upload-artifact@v7
	with:
	name: pr_docs
	path: ./docs/_build/html

	- name: Deploy to GitHub Pages
	if: github.event_name != 'pull_request' && github.repository == 'Becksteinlab/ConfoState'
	uses: peaceiris/actions-gh-pages@v4
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./docs/_build/html
	user_name: github-actions
	user_email: github-actions[bot]@users.noreply.github.com

Navigation Menu