Skip to content

About

go tool for getting pkg.go.dev documentation for untagged releases

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gobranchdocs is a tool meant to automate the process of getting pkg.go.dev module documentation for whatever the head of the current checked out branch of a given project is. This is meant to automate this process:

golang/go#36811 (comment)

Quick and dirty hack, but figured it might be useful for others. This works for whatever the current checked out branch of the package is, provided it's pushed to the remote and pkg.go.dev and proxy.golang.org can reach the remote. Upon success, it will attempt to open the appropriate pkg.go.dev package documentation page in the default browser.

Usage:

gobranchdocs [options] [path]
  -dont-open-browser
        disable opening browser url
  -pkg-go-dev-url string
        go doc url (default "https://pkg.go.dev")
  -proxy-go-url string
        proxy url (default "https://proxy.golang.org")

If no path is specified, defaults to the current directory

About

go tool for getting pkg.go.dev documentation for untagged releases

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

⌂ 换网址