Docs

Make the published Waterline service image reliably ready for signals… #257

	name: Docs

	on:
	push:
	branches: [main]
	paths:
	- 'src/**'
	- 'docs/**'
	- 'mkdocs.yml'
	- 'pyproject.toml'
	- '.github/workflows/docs.yml'
	workflow_dispatch:

	permissions:
	contents: read

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

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6

	- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
	with:
	python-version: "3.12"

	- name: Install package + docs deps
	run: pip install -e '.[docs]'

	- name: Build site
	run: mkdocs build --strict

	- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
	with:
	path: site

	deploy:
	needs: build
	if: github.ref == 'refs/heads/main'
	runs-on: ubuntu-latest
	permissions:
	contents: read
	id-token: write
	pages: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5

Navigation Menu