Skip to content

Commit 2a5e2fa

Browse files
jaimebarranclaude
andcommitted
Publish the graphify graph on GitHub Pages
The docs workflow copies graphify-out/graph.html to <site>/graph/ and also runs when the graph changes. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019Srr5n5jCmL1YyCUGDjTL5
1 parent f28f9f5 commit 2a5e2fa

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ name: Documentation
33
# Builds the Sphinx documentation (docs/rst) on every change of the docs or of the code (the API
44
# pages come from the docstrings), and publishes it to GitHub Pages from main:
55
# https://mattechlab.github.io/monalisa-python/ (Settings → Pages → Source: GitHub Actions).
6+
# The graphify graph (graphify-out/graph.html) is published next to it, at .../graph/.
67
# Warnings fail the build (-W), so that broken references are seen in pull requests.
78

89
on:
910
push:
1011
branches: [main]
11-
paths: ["docs/**", "src/**", "pyproject.toml", ".github/workflows/docs.yml"]
12+
paths: ["docs/**", "src/**", "pyproject.toml", "graphify-out/graph.html", ".github/workflows/docs.yml"]
1213
pull_request:
13-
paths: ["docs/**", "src/**", "pyproject.toml", ".github/workflows/docs.yml"]
14+
paths: ["docs/**", "src/**", "pyproject.toml", "graphify-out/graph.html", ".github/workflows/docs.yml"]
1415
workflow_dispatch:
1516

1617
permissions:
@@ -31,6 +32,8 @@ jobs:
3132
python-version: "3.12"
3233
- run: pip install -e . -r docs/requirements.txt
3334
- run: sphinx-build -W --keep-going -b html docs/rst docs/_build/html
35+
# Interactive knowledge graph of the repo (graphify), published at <site>/graph/
36+
- run: mkdir -p docs/_build/html/graph && cp graphify-out/graph.html docs/_build/html/graph/index.html
3437
- uses: actions/upload-pages-artifact@v3
3538
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
3639
with:

0 commit comments

Comments
 (0)