如何使用 godoc 为文件夹内的所有包生成 HTML 文档答案

【问题标题】：How can I generate HTML documents for all packages inside a folder using godoc如何使用 godoc 为文件夹内的所有包生成 HTML 文档
【发布时间】：2018-08-27 09:07:02
【问题描述】：

godoc -html 只为一个包生成文档。但是，我想为项目提供所有包的所有文档，就像我运行godoc -http 时一样。有了它，我可以找到所有包并从浏览器中浏览它们。

是否可以为通过godoc -html链接在一起的所有包生成 HTML 页面？

【问题讨论】：

嗯，您自己托管文档吗？还是您希望它保留在 go doc 参考中？
我认为它将是一个单独的存储库，用于保存该项目的文档（HTML 文件），因此团队中的任何人都可以轻松阅读它
stackoverflow.com/a/38338422/1267177 可能会有所帮助，也许看看，或者我会做一些 bash 脚本并在 CI 服务器中生成。

标签： go godoc

【解决方案1】：

你有两个问题：

是否可以为所有通过 godoc -html 链接在一起的包生成 HTML 页面？

没有。因为它没有实现到 godoc (https://godoc.org/golang.org/x/tools/cmd/godoc) 中。

另一个问题：

如何为文件夹中的所有包生成 HTML 文档使用 godoc

我认为最简单的方法是使用 http 标志启动 godoc：godoc -http=:6060

然后导航到要获取文档的文件夹。对于该 url，您可以使用网络爬虫来获取 html 文档。 Go 中已经有一些爬虫（https://godoc.org/?q=crawler），如果你不想自己写爬虫的话。

【讨论】：

【解决方案2】：

我开发了Golds，这是一个替代的 Go 文档生成工具（和本地文档服务器/代码阅读器）。希望这个工具能满足您的需求。

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

golds -gen -nouses -plainsrc -wdpkgs-listing=promoted ./...
golds -gen -nouses -wdpkgs-listing=promoted ./...
golds -gen -wdpkgs-listing=promoted ./...

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

【讨论】：