Website: mkdocs from the .md files, built to gh-pages on every push to main - #9
Merged
Merged
Conversation
…o main Three pages, default mkdocs theme: the README as the front page (copied at build time, image and repo links rewritten), docs/api.md (one table per group of the API) and docs/examples.md (the Colab notebook, the demo GIF, how to record your own). .github/workflows/site.yml builds with --strict on pull requests and force-pushes the built site to the orphan gh-pages branch on pushes to main, the same pattern as the demo notebook. The README links to the site. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01G9zs684RFxHvW6cNWqTPSF
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A minimal documentation site at https://arena-education.github.io/liveplot/, built from markdown only:
docs/api.md): one table per group: constructor arguments, logging, the matplotlib-named setters on axes / panels / the plot, what you get afterwards, interrupts.docs/examples.md): the Colab badge for the tour notebook, the demo GIF, and how to record your own.mkdocs.ymlis ten lines with the default theme.site.ymlbuilds with--stricton pull requests (a broken link fails the check) and, on pushes tomain, force-pushes the built site to the orphangh-pagesbranch, the same pattern as thedemonotebook branch. Nothing generated lives onmain, andpip install git+...never downloads either orphan branch (pip clones with--filter=blob:none).Verified
Built locally with the workflow's exact steps: three pages, strict mode clean, the demo GIF resolves from both the front page and the examples page.
After merging
One-time: Settings → Pages → "Deploy from a branch" →
gh-pages/ root. GitHub usually enables this automatically when the branch appears. The site is live a minute after the first workflow run onmain.Stacked on #8 (uses its Colab badge and demo branch). The API page documents the setters from #7, so merge #7 before or with this.
🤖 Generated with Claude Code
https://claude.ai/code/session_01G9zs684RFxHvW6cNWqTPSF