1# Go DocFX YAML Generator
2
3This tool generates DocFX YAML for Go modules.
4
5Only a single module will be processed at once.
6
7By default, the output files are stored at `./obj/api`. You can convert them to
8HTML using [doc-templates](https://github.com/googleapis/doc-templates) and/or
9[doc-pipeline](https://github.com/googleapis/doc-pipeline).
10
11Example usage:
12
13```
14cd module && godocfx ./...
15godocfx cloud.google.com/go/...
16godocfx -print cloud.google.com/go/storage/...
17godocfx -out custom/output/dir cloud.google.com/go/...
18godocfx -rm custom/output/dir cloud.google.com/go/...
19```
20
21## Testing
22
23You can run the tests with `go test`.
24
25If you need to update the golden files, add the `-update-goldens` flag:
26
27```
28go test -v -update-goldens
29```