I want to see locally how my package documentation will look. That is, I want to see the same kind of thing you see on godoc.org, but locally.
I have a simple example folder locally, but I can't get it to work. It correctly outputs text documentation:
~/code/go/gonotes (master) $ godoc .
PACKAGE DOCUMENTATION
package gonotes
import "."
FUNCTIONS
func Blah()
Here is header
Blah is function being use to test:
- go documentation
- blah like things
It is nice
But if I run godoc -http=:6060
, and navigate to http://localhost:6060/
, I see essentially the same content I'd see on the golang.com homepage. http://localhost:6060/gonotes
displays
lstat $GOROOT/gonotes: no such file or directory
Am I misunderstanding how the -http
works? Is there any way to preview the http version of my docs locally?
UPDATE
I was able to get it to appear by copying the files into src/gonotes
and then running:
GOPATH=/Users/jonah/code/go/gonotes godoc -http=:6060
so that the actual files were available at /Users/jonah/code/go/gonotes/src/gonotes
.
This has the side effect of not showing any of the Third part libs installed in my default GOPATH
, so I'd still like to find a solution that just allows me to add the current directory, as is, without adding src/curdir
to it, and still have it show up.