godocfx

command module
Version: v0.0.0-...-54457f5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2022 License: Apache-2.0 Imports: 30 Imported by: 0

README

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

Documentation

Overview

Command godocfx generates DocFX YAML for Go code.

Usage:

godocfx [flags] path

# New modules with the given prefix. Delete any previous output.
godocfx -rm -project my-project -new-modules cloud.google.com/go
# Process a single module @latest.
godocfx cloud.google.com/go
# Process and print, instead of save.
godocfx -print cloud.google.com/go/storage@latest
# Change output directory.
godocfx -out custom/output/dir cloud.google.com/go

See: * https://dotnet.github.io/docfx/spec/metadata_format_spec.html * https://github.com/googleapis/doc-templates * https://github.com/googleapis/doc-pipeline

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL