Generate static Go documentation
Go to file
2023-11-08 21:24:26 -08:00
.gitignore Initial commit 2020-02-06 08:37:24 -08:00
badge.svg Initial commit 2020-02-06 08:37:24 -08:00
CHANGELOG Migrate to code.rocket9labs.com 2023-11-08 21:24:26 -08:00
cmd.go Add --exclude flag and fix compilation on Windows 2020-02-07 07:38:30 -08:00
cmd_linux.go Add --exclude flag and fix compilation on Windows 2020-02-07 07:38:30 -08:00
go.mod Migrate to code.rocket9labs.com 2023-11-08 21:24:26 -08:00
go.sum Update CHANGELOG 2023-11-08 21:20:18 -08:00
LICENSE Initial commit 2020-02-06 08:37:24 -08:00
main.go Retry executing godoc 2023-11-02 23:37:17 -07:00
page.go Migrate to code.rocket9labs.com 2023-11-08 21:24:26 -08:00
README.md Migrate to code.rocket9labs.com 2023-11-08 21:24:26 -08:00

godoc-static

Donate

Generate static Go documentation

Demo

Rocket 9 Labs Documentation

Installation

Install godoc-static:

go install code.rocket9labs.com/tslocum/godoc-static@latest

Also install godoc:

go install golang.org/x/tools/cmd/godoc@latest

Documentation

To generate documentation for specific packages, execute godoc-static supplying at least one package import path and/or absolute path:

godoc-static -destination=/home/user/sites/docs fmt net/http ~/awesomeproject

When an import path is supplied, the package is sourced from $GOPATH or $GOROOT.

When no packages are supplied, documentation is generated for packages listed by go list ....

Packages are not downloaded/updated automatically.

Usage examples

Generate documentation for archive, net/http and ~/go/src/code.rocket9labs.com/tslocum/cview:

godoc-static \
    -site-name="Rocket 9 Labs Documentation" \
    -site-description-file=/home/user/sitefiles/description.md \
    -destination=/home/user/sites/docs \
    archive net/http code.rocket9labs.com/tslocum/cview

Options

-destination

Path to write site to.

-exclude

Space-separated list of packages to exclude from the index.

Link to index.html instead of folder.

-listen-address

Address for godoc to listen on while scraping pages.

-site-description

Site description (markdown-enabled).

-site-description-file

Path to markdown file containing site description.

Site footer (markdown-enabled).

Path to markdown file containing site footer.

-site-name

Site name.

-quiet

Disable all logging except errors.

-verbose

Enable verbose logging.

-zip

Site ZIP file name.

Support

Please share issues and suggestions here.