Repository navigation
Documentation site: Hugo + Hextra, built like go-notebook/docs - #1
Merged
Merged
Conversation
…-ndarray/docs The pages describe go-plot/plot v0.1.0, published under /docs/0.1/ (and latest): getting started, the API and why it has matplotlib's shape (the notebook census), every plot type, what is exact against matplotlib and how it is checked, TeX labels, performance, and the differences. The text comes from go-plot/plot's README, docs/design.md and docs/perf.md. Every figure is drawn by go-plot: figures/ is a Go module requiring go-plot v0.1.0, one file per figure, and the plotfig shortcode shows the image and then reads the file that drew it. The new `figures` CI job draws them all again and fails on any difference (byte-identical on darwin/arm64 and amd64), or if figures/go.mod and hugo.yaml name different releases. The external-link job skips the site's own URLs and this repository's files: neither exists before the first deploy / merge. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
The documentation of go-plot/plot v0.1.0, served at https://go-plot.github.io/docs/ (versioned:
/docs/0.1/,/docs/latest/).Built like go-notebook/docs and go-ndarray/docs: Hugo + the tannevaled/hextra fork (submodule, pinned at the same commit as go-notebook's), go-plot/brand as the
brandingsubmodule (mark, favicons), the version selector and outdated banner,scripts/publish-version.sh, anddocs.yml(build + offline lychee, external links, deploy togh-pages). The external-link job skips*go-plot.github.io/docs*(go-notebook/docs lesson: the site only exists after its first deploy) and*github.com/go-plot/docs/*(this repository's own files are not onmainuntil this merges).Pages (all from go-plot/plot's README,
docs/design.mdanddocs/perf.md): Home · Getting started · The API (Figure / Subplots / Axes, options for keyword arguments, data asany, and the 339-notebook census that chose the object-oriented API) · Plot types · Exactness (ticks, colours, layout, rendering comparison, negative controls) · TeX labels · Performance · Differences.Figures are real, and checked.
figures/is a Go module requiringgithub.com/go-plot/plot v0.1.0, one file per figure.{{< plotfig "name" >}}showsstatic/images/figures/<name>.svgand then readsfigures/<name>.goverbatim, so the code on the page is the code that drew the image. A newfiguresjob draws every figure again and fails if an image differs (verified byte-identical on darwin/arm64 and amd64), or iffigures/go.modrequires another go-plot thanparams.plot.version.Colour: the brand blue (
#1F77B4light,#5AAEE6dark) as Hextra's primary.🤖 Generated with Claude Code