Build your golang package docs locally

last updated: Oct 20, 2023

https://mdaverde.com/posts/golang-local-docs/

Similar to my Rust setup, I wanted to see a rendering of my module docs as they would on pkg.go.dev locally before publishing. This used to be possible with godoc but it's been deprecated since then with no official solution.

The recommendation now is to point users to pkgsite (the tool used to render pkg.go.dev) but it's left as an exercise to the user on exactly what the setup should be.

So let's do the exercise.

The golang documentation situation is awful and not improving, sadly

↑ up