docs

Merge pull request #477 from VectorInstitute/pre-commit-ci-update-config #105

	name: docs

	on:
	push:
	branches:
	- main
	paths:
	- .pre-commit-config.yaml
	- .github/workflows/code_checks.yml
	- .github/workflows/docs_build.yml
	- '**.py'
	- '**.ipynb'
	- '**.html'
	- '**.js'
	- poetry.lock
	- pyproject.toml
	- '**.rst'
	- '**.md'
	workflow_dispatch:

	jobs:
	deploy:
	runs-on: ubuntu-latest
	permissions:
	contents: write
	pages: write # Work with github pages
	steps:
	- uses: actions/checkout@v6
	with:
	submodules: 'true'
	- name: Install dependencies and build docs
	run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
	- uses: actions/setup-python@v6
	with:
	python-version: '3.10'
	cache: 'poetry'
	- name: Build Docs
	run: \|
	python3 -m pip install --upgrade pip && python3 -m pip install poetry
	poetry env use '3.10'
	source $(poetry env info --path)/bin/activate
	poetry install --with docs,test
	cd docs && rm -rf source/reference/api/_autosummary && make html
	- name: Deploy to Github pages
	uses: JamesIves/[email protected]
	with:
	branch: github_pages
	folder: docs/build/html

Provide feedback