Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gddo: support repository with no top-level .go files, only sub-packages #618

Open
rcoreilly opened this issue May 7, 2019 · 0 comments

Comments

@rcoreilly
Copy link

commented May 7, 2019

What version of Go are you using (go version)?

$ go version
This is about hosted godoc.org

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (go env)?

go env Output
$ go env

What did you do?

Tried to load my docs on godoc.org, searching github.com/emer/emergent -- (i.e., https://github.com/emer/emergent ) -- it couldn't find it.

What did you expect to see?

the docs.

What did you see instead?

nothing.

The problem appears to be that I organize my repositories without any top-level .go files, and put the eponymous package as a subdirectory, because then the view on github is cleaner (the README is right there instead of listed after all the source) and it is cleaner to navigate in my editor / file browser, and just generally seems like a better way to keep things organized.

Without finding any of these .go files, the godoc search daemon must conclude that this is not a go repository.

A good workaround is to create a top-level doc.go file, which then serves as the overview of the entire repository, as well as fixing this particular issue.

Of course, I just came up with this idea while filing this ticket, so I'll go ahead and file the ticket in case anyone else comes across the same issue, or in case the godoc tool could be made slightly more robust and look in the first-level subdirectories for .go files as well.. If that is too much of a PITA, just close the ticket.

@andybons andybons transferred this issue from golang/go May 8, 2019

@andybons andybons changed the title godoc support repository with no top-level .go files, only sub-packages? support repository with no top-level .go files, only sub-packages May 8, 2019

@andybons andybons changed the title support repository with no top-level .go files, only sub-packages gddo: support repository with no top-level .go files, only sub-packages May 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.