tree: 4f557384e9aa7911a4bee23bf7773c7bed6120e9 [path history] [tgz]
  1. pkgload/
  2. testdata/
  3. .gitignore
  4. go.mod
  5. go.sum
  6. godocfx_test.go
  7. index.go
  8. index_test.go
  9. main.go
  10. parse.go
  12. timesaver.go

Go DocFX YAML Generator

This tool generates DocFX YAML for Go modules.

Only a single module will be processed at once.

By default, the output files are stored at ./obj/api. You can convert them to HTML using doc-templates and/or doc-pipeline.

Example usage:

cd module && godocfx ./...
godocfx -print
godocfx -out custom/output/dir
godocfx -rm custom/output/dir


You can run the tests with go test.

If you need to update the golden files, add the -update-goldens flag:

go test -v -update-goldens