tree: c499ff286ff11382e91e5c9e9b7c8faddcbc8bd0 [path history] [tgz]
  1. .gitignore
  2. go.mod
  3. go.sum
  4. godocfx_test.go
  5. main.go
  6. parse.go
  7. README.md
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/...