tree: c86513415d9dbfcd0d4394c78593fd5a3aa5eb9a [path history] [tgz]
  1. testdata/
  2. .gitignore
  3. go.mod
  4. go.sum
  5. godocfx_test.go
  6. index.go
  7. index_test.go
  8. main.go
  9. parse.go
  11. 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