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.

Sign up for GitHub

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

x/tools/cmd/godoc: support exporting HTML documentation #39272

Closed
akoserwal opened this issue May 27, 2020 · 5 comments
Closed

x/tools/cmd/godoc: support exporting HTML documentation #39272

akoserwal opened this issue May 27, 2020 · 5 comments
Labels
Documentation FrozenDueToAge Tools This label describes issues relating to any tools in the x/tools repository. WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Milestone
Unreleased

Comments

@akoserwal
Copy link

akoserwal commented May 27, 2020 •
edited

Is there a way to generate a godoc for a module/package or export the generated documentation in a static file format?

Currently way of generating docs:
godoc -http=:PORT

Can we add an export button mechanism to the page? That can export the document for the entire project.
@andybons andybons changed the title Export documentation generated using godoc x/tools/cmd/godoc: support exporting HTML documentation May 27, 2020
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label May 27, 2020
@gopherbot gopherbot added this to the Unreleased milestone May 27, 2020
@andybons andybons added the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label May 27, 2020
@andybons
Copy link
Member

What is your use-case for this feature? Thanks.

@akoserwal
Copy link
Author

akoserwal commented May 27, 2020 •
edited

@andybons I am looking for suitable ways of generating go documents for Kubernetes Operators generated using operator-sdk or add go docs to a library as static formate.

@andybons
Copy link
Member

If you’re proposing adding a button (which seems to indicate that you’re not looking to automate it?), why not use the browser’s “Save page as” feature that will output static documentation for you?

@akoserwal
Copy link
Author

I am looking for an automated way. Something
godoc project/module/file with the export flag for providing file format. Similar javadoc file_name or javadoc package_name or a button on the main page of module/project which allows exporting the entire project pages.

@agnivade
Copy link
Contributor

Duplicate of #2381.

@golang golang locked and limited conversation to collaborators May 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge Tools This label describes issues relating to any tools in the x/tools repository. WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@andybons @agnivade @akoserwal @gopherbot