Docs

v0.1.0 #1

	name: Docs

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

	permissions:
	contents: write


	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 (strict)
	run: zensical build --strict -f docs/mkdocs.yml

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

	deploy:
	needs: build
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	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: Deploy to GitHub Pages
	run: zensical gh-deploy --force --clean -f docs/mkdocs.yml

Navigation Menu