如何使用 godoc 为文件夹内的所有包生成 HTML 文档
How can I generate HTML documents for all packages inside a folder using godoc
godoc -html
只为一个包生成文档。但是,我想将项目与所有包的所有文档一起发送,就像我 运行 godoc -http
时一样。有了它,我可以找到所有包并从浏览器中浏览它们。
是否可以为 通过 godoc -html
链接在一起 的所有包生成 HTML 页面?
你有两个问题:
Is it possible to generate HTML pages for all packages linked together through godoc -html?
没有。因为没有实现到godoc中(https://godoc.org/golang.org/x/tools/cmd/godoc).
另一个问题:
How can I generate HTML documents for all packages inside a folder
using godoc
我认为最简单的方法是使用http标志启动godoc:godoc -http=:6060
然后导航到要获取文档的文件夹。对于 url,您可以使用网络爬虫获取 html 文档。如果不想自己写爬虫的话,Go里面已经有爬虫了(https://godoc.org/?q=crawler)
我开发了 Golds,这是一个备用的 Go 文档生成工具(和一个本地文档服务器/代码 reader)。希望这个工具能满足您的需求。
在您的项目目录下,您可以运行以下任何命令为您的 Go 项目生成 HTML 文档:
- golds -gen -nouses -plainsrc -wdpkgs-listing=晋升./...
- 金牌 -gen -nouses -wdpkgs-listing=晋级 ./...
- 金牌-gen -wdpkgs-listing=晋级./...
第一个命令生成最紧凑的文档,最后一个命令生成完整文档,大小是紧凑文档的6倍。
godoc -html
只为一个包生成文档。但是,我想将项目与所有包的所有文档一起发送,就像我 运行 godoc -http
时一样。有了它,我可以找到所有包并从浏览器中浏览它们。
是否可以为 通过 godoc -html
链接在一起 的所有包生成 HTML 页面?
你有两个问题:
Is it possible to generate HTML pages for all packages linked together through godoc -html?
没有。因为没有实现到godoc中(https://godoc.org/golang.org/x/tools/cmd/godoc).
另一个问题:
How can I generate HTML documents for all packages inside a folder using godoc
我认为最简单的方法是使用http标志启动godoc:godoc -http=:6060
然后导航到要获取文档的文件夹。对于 url,您可以使用网络爬虫获取 html 文档。如果不想自己写爬虫的话,Go里面已经有爬虫了(https://godoc.org/?q=crawler)
我开发了 Golds,这是一个备用的 Go 文档生成工具(和一个本地文档服务器/代码 reader)。希望这个工具能满足您的需求。
在您的项目目录下,您可以运行以下任何命令为您的 Go 项目生成 HTML 文档:
- golds -gen -nouses -plainsrc -wdpkgs-listing=晋升./...
- 金牌 -gen -nouses -wdpkgs-listing=晋级 ./...
- 金牌-gen -wdpkgs-listing=晋级./...
第一个命令生成最紧凑的文档,最后一个命令生成完整文档,大小是紧凑文档的6倍。