Docs

Python: expose metadata in channel constructors #330

	name: Docs

	on:
	push:
	branches: [main]
	tags: ["**"]
	pull_request: {}

	jobs:
	build-cpp-docs:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: ssciwr/doxygen-install@v1
	with:
	version: "1.13.2"
	- run: pipx install poetry
	working-directory: cpp/foxglove/docs
	- run: poetry install
	working-directory: cpp/foxglove/docs
	- run: make docs
	working-directory: cpp
	- name: Upload artifact
	uses: actions/upload-artifact@v4
	with:
	name: cpp
	path: ./cpp/build/docs/html
	if-no-files-found: error

	build-python-docs:
	runs-on: ubuntu-latest
	defaults:
	run:
	working-directory: python/foxglove-sdk
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v5
	with:
	python-version: "3.9"
	- run: pipx install poetry
	- run: poetry install
	- run: poetry run maturin develop
	- name: Sphinx build
	run: \|
	poetry run sphinx-build --fail-on-warning ./python/docs ./python/docs/_build
	- name: Upload artifacts
	uses: actions/upload-artifact@v4
	with:
	name: python
	path: python/foxglove-sdk/python/docs/_build
	if-no-files-found: error

	deploy-docs:
	runs-on: ubuntu-latest
	permissions:
	contents: write
	needs: [build-cpp-docs, build-python-docs]
	if: startsWith(github.ref, 'refs/tags/sdk/v')
	steps:
	- name: Download artifacts
	uses: actions/download-artifact@v4
	with:
	path: artifacts
	- run: test -d artifacts/python
	- run: test -d artifacts/cpp
	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v4
	with:
	publish_branch: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: artifacts/
	force_orphan: true

Provide feedback