tree: 475462d1884751c15bdc7210a01092c8b9957b77 [path history] [tgz]
  1. .gitignore
  2. README.md
  3. go.mod
  4. go.sum
  5. godocfx_test.go
  6. main.go
  7. parse.go
  8. testdata/
internal/godocfx/README.md

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 cloud.google.com/go/...
godocfx -print cloud.google.com/go/storage/...
godocfx -out custom/output/dir cloud.google.com/go/...
godocfx -rm custom/output/dir cloud.google.com/go/...

Testing

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