The go-approx documentation site, published at https://go-approx.github.io/docs/.
Hugo with the Hextra theme (the
tannevaled/hextra fork, submodule themes/hextra, pinned at v0.16.0), built
like the go-numerics documentation with
go-approx's branding. It documents
go-approx/interp and
go-approx/poly, one section each,
summarising the library's README with its verification, its performance and
its release status (interp released v0.2.1, poly released v0.1.0).
| source | published at |
|---|---|
branch main, with params.libraries in hugo.yaml |
https://go-approx.github.io/docs/<MAJOR.MINOR>/, or /docs/main/ |
the newest version (else main) |
also https://go-approx.github.io/docs/latest/ |
https://go-approx.github.io/docs/ redirects to latest/. Each push to
main replaces its version's directory on the gh-pages branch
(scripts/publish-version.sh) and keeps every other version. To document a new
release, set its tag in params.libraries and update the pages.
| Path | What |
|---|---|
content/en/ |
the pages: home, then one section per library |
hugo.yaml |
site configuration, params.libraries |
assets/css/custom.css |
the brand orange as Hextra's primary colour, the table headers |
layouts/_partials/ |
favicons from the brand kit, the version selector, the outdated-version banner |
scripts/publish-version.sh |
publishes one build into the gh-pages checkout |
themes/hextra |
submodule: the Hextra fork |
branding |
submodule: go-approx/brand (the mark, its PNGs and ICO) |
git clone --recurse-submodules https://github.com/go-approx/docs.git
cd docs
hugo serverHugo extended is not required; no Node.
| Workflow | What |
|---|---|
docs.yml build |
builds the site with --panicOnWarning and checks internal links and anchors offline |
docs.yml links |
every external link in the pages resolves |
docs.yml deploy |
on main, publishes the build to gh-pages |
BSD-3-Clause.