Skip to content

Commit

Permalink
Merge pull request #612 from planetscale/better-docs
Browse files Browse the repository at this point in the history
Update `docs/api.md` and automatically update it
  • Loading branch information
frouioui authored Oct 14, 2024
2 parents e61f50f + 835a18e commit 5545c3d
Show file tree
Hide file tree
Showing 4 changed files with 3,781 additions and 2,193 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ integration-test:
generate:
go run sigs.k8s.io/controller-tools/cmd/controller-gen object crd:maxDescLen=0 paths="./pkg/apis/planetscale/v2" output:crd:artifacts:config=./deploy/crds
go run github.com/ahmetb/gen-crd-api-reference-docs -api-dir planetscale.dev/vitess-operator/pkg/apis/planetscale/v2 -config ./docs/api/config.json -template-dir ./docs/api/template -out-file ./docs/api/index.html
@echo 'Copying ./docs/api/index.html to ./docs/api.md'
@cp ./docs/api/index.html ./docs/api.md && ex -sc '1,2d|x' ./docs/api.md
@echo 'Written to ./docs/api.md'

generate-and-diff: generate
git add --all
Expand Down
Loading

0 comments on commit 5545c3d

Please sign in to comment.