Skip to content

Docs: API Docs Fail to Generate #1421

@danehans

Description

@danehans

What happened:

The tagrets for generating API docs fail:

$ make apix-ref-docs
crd-ref-docs \
		--source-path=/Users/solo-system-dhansen/go/src/sigs.k8s.io/gateway-api-inference-extension/apix/v1alpha2 \
		--config=crd-ref-docs.yaml \
		--renderer=markdown \
		--output-path=/Users/solo-system-dhansen/go/src/sigs.k8s.io/gateway-api-inference-extension/site-src/reference/x-spec.md
bash: line 1: crd-ref-docs: command not found
make: *** [apix-ref-docs] Error 127

$ make api-ref-docs
crd-ref-docs \
		--source-path=/Users/solo-system-dhansen/go/src/sigs.k8s.io/gateway-api-inference-extension/api \
		--config=crd-ref-docs.yaml \
		--renderer=markdown \
		--output-path=/Users/solo-system-dhansen/go/src/sigs.k8s.io/gateway-api-inference-extension/site-src/reference/spec.md
bash: line 1: crd-ref-docs: command not found
make: *** [api-ref-docs] Error 127

What you expected to happen:

The targets to succeed and the API docs are updated.

How to reproduce it (as minimally and precisely as possible):
Clone the repo and run the make targets.

Anything else we need to know?:

N/A

Environment:

N/A

Metadata

Metadata

Assignees

Labels

help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/bugCategorizes issue or PR as related to a bug.triage/acceptedIndicates an issue or PR is ready to be actively worked on.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions