Viewing the documentation locally¶

There are two complementary sets of documentation, and you can serve either of them on your own machine:

• The API / source-code reference — generated from the Go source by pkgsite.
• This documentation site — the hand-written guides you are reading now, built with zensical.

API reference (pkgsite)¶

pkgsite serves the Go source documentation (every package, type, and function) as a local website.

Install it once:

go install golang.org/x/pkgsite/cmd/pkgsite@latest

Then run it from the repository root and open http://127.0.0.1:8080 in your browser:

cd goxpyriment
pkgsite

To jump straight to a package, append its import path, for example the stimuli package:

http://localhost:8080/github.com/chrplr/goxpyriment@v0.0.0/stimuli

This documentation site (zensical)¶

The guides on this site are built with zensical. Install it once (it is listed in docs/requirements.txt):

pip install -r docs/requirements.txt

(or follow the zensical get-started guide).

Then, from the repository root, start a live-reload preview at http://127.0.0.1:8000:

zensical serve        # or: make serve

To produce a static HTML build in site/ instead:

zensical build --clean   # or: make docs