How to run godoc on some popular go repo?

Question

New godoc have some nice features like list of callers etc. Anyway I have problems to run it, like:

➜  ~GOPATH git:(master) ✗ ls src/github.com/coreos/etcd/
CHANGELOG       DCO             Documentation   README.md       bench           build           contrib         error           fixtures        go_version.go   http            main.go         mod             scripts         store           tests
CONTRIBUTING.md Dockerfile      LICENSE         Vagrantfile     bin             config          discovery       etcd            foo             gopath          log             metrics         pkg             server          test.sh         third_party
➜  ~GOPATH git:(master) ✗ godoc github.com/coreos/etcd/discovery -http=:6060
No match found.

Does anyone can tell me how to run it on some popular go repos like etcd, which I am using above?

I see: `-http=:6060` doesn't seem to work when given a package. Either give a package name _or_ `-http=:6060` — topskip, Jun 25 '14 at 16:25

score 1 · Answer 1 · answered Jun 25 '14 at 19:39

1

Godoc have two main functionnalities:

It displays the documentation for a package
It run a webserver that you can browse to see you local packages documentation

Here, you are trying to do both at the same time. Either remove the -http=:6060 option to see the package documentation in the console, or remove the package path to run the webserver and search it in your browser.

answered Jun 25 '14 at 19:39

Elwinar

9,103
32
40

I tried to run with http option, but what I am getting is just local version of go website.... – Sławosz Jun 26 '14 at 08:37
But the package list should include your local packages. – Elwinar Jun 26 '14 at 08:40
1

Ok, so I am making something wrong since I have only std lib docs :( – Sławosz Jun 26 '14 at 14:26

score 0 · Answer 2 · answered Aug 05 '14 at 22:59

Godoc can either run documentation on your code to create output on the terminal (running godoc without -server or -http flags), or can be run as a server with -http/-server tags (and takes no other args). Can't be both at the same time.

If you don't see your code in packages, then you need to run go install mypackage For example if you have github.com/coreos/etcd/discovery cloned, then run go install github.com/coreos/etcd/discovery and it should appear in the go docs page run by godoc -http=:port

Just ran into this problem with my code and didn't see any other answers.

score 0 · Answer 3 · answered Sep 21 '17 at 21:03

0

godoc -http=:6060 &
go get github.com/coreos/etcd/discovery
open http://localhost:6060/pkg/github.com/coreos/etcd/discovery

answered Sep 21 '17 at 21:03

dolmen

8,126
5
40
42

That's a great response, also, if you are unhappy about godoc's output, you can also use this one: https://github.com/dataf3l/go-doc – Felipe Valdes Aug 12 '18 at 23:26

How to run godoc on some popular go repo?

3 Answers3