-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: automate creating api references with new make command
- Loading branch information
1 parent
24a5ad7
commit afc0db1
Showing
57 changed files
with
24,468 additions
and
1,321 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
996 changes: 580 additions & 416 deletions
996
api/proto/raystack/guardian/v1beta1/guardian.pb.gw.go
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.