Skip to content

Commit

Permalink
docs: automate creating api references with new make command
Browse files Browse the repository at this point in the history
  • Loading branch information
Chief-Rishab committed Nov 15, 2023
1 parent 24a5ad7 commit afc0db1
Show file tree
Hide file tree
Showing 57 changed files with 24,468 additions and 1,321 deletions.
12 changes: 10 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,18 @@ setup: ## Install all the dependencies
go install github.com/golang/protobuf/[email protected]
go install github.com/golang/protobuf/[email protected]
go install google.golang.org/[email protected]
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1.0
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.29.0
go install github.com/grpc-ecosystem/grpc-gateway/v2/[email protected]
go install github.com/grpc-ecosystem/grpc-gateway/v2/[email protected]
go install github.com/bufbuild/buf/cmd/buf@v1.15.1
go install github.com/bufbuild/buf/cmd/buf@v1.29.0

help: ## Display this help message
@cat $(MAKEFILE_LIST) | grep -e "^[a-zA-Z_\-]*: *.*## *" | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

doc: ## Generate api documentation
@echo ">genetate api docs"
@cd $(CURDIR)/docs/docs; yarn docusaurus clean-api-docs all; yarn docusaurus gen-api-docs all

doc-build: ## Run documentation locally
@echo "> building docs"
@cd $(CURDIR)/docs/docs; yarn start
2 changes: 1 addition & 1 deletion api/proto/raystack/guardian/v1beta1/guardian.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

996 changes: 580 additions & 416 deletions api/proto/raystack/guardian/v1beta1/guardian.pb.gw.go

Large diffs are not rendered by default.

Loading

0 comments on commit afc0db1

Please sign in to comment.