Generate API reference using Make #191
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was helpful to generate the API docs locally so I can preview and run the link checker to check for broken links. Adds the `tools/go.mod` so the version of `crd-ref-docs` can be pinned, and the tool can be run using `go run`. In essence one can do `make api-docs` to generate the Markdown files in `content/ref`. There is a small issue with the `service-provider-integration-operator`, it needs an additional `go mod tidy` if golang version is newer than 1.20. To fix that run `make api-docs` once to clone the repository, then `cd crd-temp/service-provider && go mod tidy` and rerun `make api-docs`.
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This was helpful to generate the API docs locally so I can preview and run the link checker to check for broken links.
Adds the
tools/go.modso the version ofcrd-ref-docscan be pinned, and the tool can be run usinggo run.In essence one can do
make api-docsto generate the Markdown files incontent/ref. There is a small issue with theservice-provider-integration-operator, it needs an additionalgo mod tidyif golang version is newer than 1.20. To fix that runmake api-docsonce to clone the repository, thencd crd-temp/service-provider && go mod tidyand rerunmake api-docs.