docs

Add edge-weight metadata documentation #32

	name: docs

	on:
	push:
	branches: [main]
	workflow_dispatch:

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

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

	jobs:
	build:
	runs-on: ubuntu-latest

	steps:
	- name: Check out repository
	uses: actions/checkout@v4

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

	- name: Set up Pages
	uses: actions/configure-pages@v5

	- name: Install Graphviz
	run: \|
	sudo apt-get update
	sudo apt-get install -y graphviz

	- name: Install package and docs dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[docs]

	- name: Execute documentation notebooks
	run: \|
	python -m jupyter nbconvert \
	--to notebook \
	--execute \
	--inplace \
	--ExecutePreprocessor.kernel_name=python3 \
	docs/getting-started.ipynb

	python -m jupyter nbconvert \
	--to notebook \
	--execute \
	--inplace \
	--ExecutePreprocessor.kernel_name=python3 \
	docs/feedforward-skip-edges.ipynb

	- name: Build docs
	run: \|
	mkdocs build

	- name: Upload Pages artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: site

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build

	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Navigation Menu