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

Jump to bottom

cmd/doc: support custom output format #41744

Open
CAFxX opened this issue Oct 2, 2020 · 3 comments
Open

cmd/doc: support custom output format #41744

CAFxX opened this issue Oct 2, 2020 · 3 comments
Labels
FeatureRequest NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Unplanned

Comments

@CAFxX
Copy link
Contributor

CAFxX commented Oct 2, 2020 •
edited

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

1.15.2

Does this issue reproduce with the latest release?

yes

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

darwin/amd64

What did you do?

I am using go doc to automatically generate static documentation for internal repositories.

What did you expect to see?

A way to provide a text/template to control the output format or, alternatively, a way to output the data in a standard machine-parseable format (e.g. json, yaml, ...) that I can use to drive custom output generation.

What did you see instead?

go doc does only provide a single format for direct human consumption.
@CAFxX CAFxX changed the title cmd/doc: add support for templates cmd/doc: support custom output format Oct 2, 2020
@robpike
Copy link
Contributor

robpike commented Oct 2, 2020

The program really wasn't written with that in mind. It might be convertible but it would be a lot of work. You'd likely be better off hacking up something using go/doc directly.

@go101 go101 mentioned this issue Oct 4, 2020
Open
@dmitshur dmitshur added FeatureRequest NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Oct 6, 2020
@dmitshur dmitshur added this to the Unplanned milestone Oct 6, 2020
@icholy
Copy link

icholy commented May 19, 2021 •
edited

I used the (now changed) godoc -templates flag to implement go doc tab completion for zsh: https://github.com/ohmyzsh/ohmyzsh/blob/d646884add277d134235a9b18ab755388d6e0d8d/plugins/golang/golang.plugin.zsh#L68

It's unfortunate that there's no alternative with the current tooling.

@icholy
Copy link

icholy commented Jan 21, 2023

@robpike what about a --json flag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
FeatureRequest NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Milestone
Unplanned
Development

No branches or pull requests
4 participants
@CAFxX @icholy @dmitshur @robpike