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

Question

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

Answer 1

可以通过以下方式生成简单的HTML文档：

$ godoc -html container/heap Interface > page.html

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

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

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

如果与Go存储库中的原始CSS样式结合使用，通过调整生成的HTML文件以正确引用它，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文档：

• 金-gen -nouses -plainsrc -emphasize-wdpkgs ./...
• 金-gen -nouses -emphasize-wdpkgs ./...
• 金-gen -emphasize-wdpkgs ./...

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

顺便说一句，我是黄金的作者。希望您能使用此工具满足您的需求。