gobranchdocs

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 29, 2022 License: MIT Imports: 12 Imported by: 0

README

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:

https://github.com/golang/go/issues/36811#issuecomment-579404726

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

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL