search

golang / gddo

Go Doc Dot Org
https://godoc.org
BSD 3-Clause "New" or "Revised" License
1.1k stars 266 forks source link

How to get project onto godoc #624

Open abergmeier opened 5 years ago

abergmeier commented 5 years ago

I am wondering what it takes to get https://github.com/abergmeier/golang-protobuf into godoc. There seems to be zero documentation about which magic is necessary to make it appear. And currently it does not :cry:

shantuo commented 5 years ago

The reason is that the repo root doesn't have Go files. Try visit https://godoc.org/github.com/abergmeier/golang-protobuf/csvpb it should work.

abergmeier commented 5 years ago

So I assume, that https://godoc.org/github.com/abergmeier/golang-protobuf now starts to show up, since I added a second directory, which contains go files? Would be great if directories containing a go.mod would also be shown by default.

notatestuser commented 4 years ago

Noticed the same problem. Once I accessed a sub-package in a package that doesn't contain go files in its root godoc began to index it. I think the suggestion to look for a go.mod is good one!