docgen/

directory
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2023 License: Apache-2.0

README

Generate API Docs

Install doc generator

go install github.com/ahmetb/gen-crd-api-reference-docs@v0.3.0

Generate html docs

cd docgen

gen-crd-api-reference-docs -config config.json -api-dir "../pkg/apis/applicationnetworking/v1alpha1/" -out-file docs.html

Add generated content to template

cat api-reference-base.md docs.html > ../docs/api-reference.md

Directories

Path Synopsis
Placeholder file to make Go vendor this directory properly.
Placeholder file to make Go vendor this directory properly.

Jump to

Keyboard shortcuts

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