Docs

Dev #6

	name: Docs

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

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: pages
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	cache: pip

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

	- name: Build docs
	run: zensical build -f docs/mkdocs.yml

	- name: Upload pages artifact
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	uses: actions/upload-pages-artifact@v3
	with:
	path: docs/site

	deploy:
	needs: build
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deploy.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deploy
	uses: actions/deploy-pages@v4

Navigation Menu