go - 如何使用 `godoc` 生成 HTML 文档？

Question

我写了一个小go程序，我想从源代码生成独立的HTML文档，可以在没有godoc服务器的情况下查看。但我找不到任何方法来实现它。如果有人可以帮助我，我将不胜感激。

Answer 1

更好的形式可以通过以下方式产生：

godoc -url "http://localhost:6060/pkg/container/heap/" > page.html 

（我的 godoc 服务器在 :6060 运行，我不确定这是否是先决条件）。

如果通过调整生成的 HTML 文件以正确引用它，结合在 Go 存储库中找到的原始 CSS 样式，HTML 可能看起来会更好。

Answer 2

这可能不会直接回答您的问题，但如果您打算开源您的项目，您实际上不必手动生成 HTML。只需确保您在源代码中正确插入了注释，并使用 godoc.org( http://godoc.org/-/about ) 来处理它。

它在 Bitbucket、Github、Launchpad 和 Google Project Hosting 上显示 Go 包的文档。

例如： http: //godoc.org/code.google.com/p/go.crypto/ssh

Answer 3

运行服务器并使用 wget 获取它

godoc -http=:6060

等待它启动然后（“容器/堆/”与您的应用程序）：

wget -p -k http://localhost:6060/pkg/container/heap/

要下载所有文档，我使用以下内容：

wget -m -k -q -erobots=off --no-host-directories --no-use-server-timestamps http://localhost:6060

Answer 4

（从https://stackoverflow.com/a/63905155/3715832移动）

如果你想尝试不同的文档风格，你可以试试Golds，这是一个替代的 Go 文档生成工具（和本地文档服务器/代码阅读器）。

在您的项目目录下，您可以运行以下任何命令来为您的 Go 项目生成 HTML 文档：

• golds -gen -nouses -plainsrc -wdpkgs-listing=promoted ./...
• golds -gen -nouses -wdpkgs-listing=promoted ./...
• golds -gen -wdpkgs-listing=提升 ./...

第一个命令生成最紧凑的文档，最后一个命令生成完整的文档，其大小是紧凑文档的 6 倍。

顺便说一句，我是Golds的作者。希望你这个工具能满足你的需要。