https://github.com/nathanejohnson/gobranchdocs

go tool for getting pkg.go.dev documentation for untagged releases
https://github.com/nathanejohnson/gobranchdocs

Last synced: 26 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/nathanejohnson/gobranchdocs
• Owner: nathanejohnson
• License: mit
• Created: 2022-05-28T23:07:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-29T01:16:10.000Z (over 2 years ago)
• Last Synced: 2024-06-21T02:15:37.720Z (5 months ago)
• Language: Go
• Size: 12.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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