crd-ref-docs
crd-ref-docs copied to clipboard
elastic
Generates Kubernetes CRD API reference documentation
This PRs makes it possible to render imported types in a CRD. For instance: ```go package v1alpha1 import ( metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "github.com/starwars/jedi/pkg/weapons" ) // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // +kubebuilder:storageversion //...
fix #71, tested with https://github.com/airycanon/crd-ref-docs/releases/tag/v0.0.1
`markdownRenderFieldDoc` should espace `{` and `}`.
#73 changed (fixed) the behavior of `ignoreTypes` so that they are actually excluded from the output. I was previously using the `ignoreTypes` list to ignore types that are only embedded...
Currently, the binaries are released for x86_64 which does not support working in arm machines. It would be great if arm binaries are provided as well :)
It would be nice if this tool could generate example resource definitions as they do here: https://docs.confluent.io/operator/current/blueprints/cob-api-cluster.html#tag/KafkaCluster
The current headers in the markdown template are not guaranteed to be unique since they do not include the version. For my use case I have multiple versions of a...
I used crd-ref-docs to generate API documentation for a multi-version CRD. ```markdown # API Reference ## Packages - [example.dev/v1](#exampledevv1) - [example.dev/v2](#exampledevv2) ## example.dev/v1 ### Resource Types - [Foo](#foo) - [FooList](#foolist)...
It would be nice to be able to get the version of the binary through a flag eg. `crd-ref-docs --version`. We rely on doing this in order to ensure that...
