docs: add wasm commands to auto-generated docs (#2172)

axelarnetwork · Aug 22, 2024 · d18dcd6 · d18dcd6
1 parent fa154e3
commit d18dcd6
Show file tree

Hide file tree

Showing 139 changed files with 1,949 additions and 135 deletions.
diff --git a/Makefile b/Makefile
@@ -69,9 +69,6 @@ go.sum: go.mod
 		@echo "--> Ensure dependencies have not been modified"
 		GO111MODULE=on go mod verify
 
-# Uncomment when you have some tests
-# test:
-# 	@go test -mod=readonly $(PACKAGES)
 .PHONY: lint
 # look into .golangci.yml for enabling / disabling linters
 lint:
@@ -172,9 +169,24 @@ prereqs:
 
 # Run all the code generators in the project
 .PHONY: generate
-generate: prereqs
+generate: prereqs docs generate-mocks
+
+.PHONY: generate-mocks
+generate-mocks:
 	go generate -x ./...
 
+.PHONY: docs
+docs:
+	@echo "Removing old clidocs"
+
+	@if find docs/cli -name "*.md"  | grep -q .; then \
+		rm docs/cli/*.md; \
+	fi
+
+	@echo "Generating new cli docs"
+	@go run $(BUILD_FLAGS) cmd/axelard/main.go --docs docs/cli
+	@# ensure docs are canonically formatted
+	@mdformat docs/cli/*
 
 .PHONE: tofnd-client
 tofnd-client:

diff --git a/cmd/axelard/genDocs.sh b/cmd/axelard/genDocs.sh
diff --git a/cmd/axelard/main.go b/cmd/axelard/main.go
@@ -24,8 +24,6 @@ import (
 	"github.com/axelarnetwork/axelar-core/cmd/axelard/cmd/utils"
 )
 
-//go:generate ./genDocs.sh ../../docs/cli
-
 func main() {
 	docs := flag.String("docs", "", "only generate documentation for the CLI commands into the specified folder")
 	flag.Parse()

diff --git a/docs/cli/axelard_debug_addr.md b/docs/cli/axelard_debug_addr.md
diff --git a/docs/cli/axelard_debug_pubkey.md b/docs/cli/axelard_debug_pubkey.md
diff --git a/docs/cli/axelard_debug_raw-bytes.md b/docs/cli/axelard_debug_raw-bytes.md
diff --git a/docs/cli/axelard_gentx.md b/docs/cli/axelard_gentx.md
diff --git a/docs/cli/axelard_migrate.md b/docs/cli/axelard_migrate.md
diff --git a/docs/cli/axelard_query.md b/docs/cli/axelard_query.md
diff --git a/docs/cli/axelard_query_auth_module-account.md b/docs/cli/axelard_query_auth_module-account.md
diff --git a/docs/cli/axelard_query_bank_balances.md b/docs/cli/axelard_query_bank_balances.md
diff --git a/docs/cli/axelard_query_bank_denom-metadata.md b/docs/cli/axelard_query_bank_denom-metadata.md
diff --git a/docs/cli/axelard_query_bank_total.md b/docs/cli/axelard_query_bank_total.md
diff --git a/docs/cli/axelard_query_distribution_commission.md b/docs/cli/axelard_query_distribution_commission.md
diff --git a/docs/cli/axelard_query_distribution_community-pool.md b/docs/cli/axelard_query_distribution_community-pool.md
diff --git a/docs/cli/axelard_query_distribution_rewards.md b/docs/cli/axelard_query_distribution_rewards.md
diff --git a/docs/cli/axelard_query_distribution_slashes.md b/docs/cli/axelard_query_distribution_slashes.md
diff --git a/docs/cli/axelard_query_distribution_validator-outstanding-rewards.md b/docs/cli/axelard_query_distribution_validator-outstanding-rewards.md
diff --git a/docs/cli/axelard_query_evidence.md b/docs/cli/axelard_query_evidence.md
diff --git a/docs/cli/axelard_query_feegrant_grant.md b/docs/cli/axelard_query_feegrant_grant.md
diff --git a/docs/cli/axelard_query_feegrant_grants-by-grantee.md b/docs/cli/axelard_query_feegrant_grants-by-grantee.md
diff --git a/docs/cli/axelard_query_feegrant_grants-by-granter.md b/docs/cli/axelard_query_feegrant_grants-by-granter.md
diff --git a/docs/cli/axelard_query_gov_deposit.md b/docs/cli/axelard_query_gov_deposit.md
diff --git a/docs/cli/axelard_query_gov_deposits.md b/docs/cli/axelard_query_gov_deposits.md
diff --git a/docs/cli/axelard_query_gov_param.md b/docs/cli/axelard_query_gov_param.md
diff --git a/docs/cli/axelard_query_gov_params.md b/docs/cli/axelard_query_gov_params.md
diff --git a/docs/cli/axelard_query_gov_proposal.md b/docs/cli/axelard_query_gov_proposal.md
diff --git a/docs/cli/axelard_query_gov_proposals.md b/docs/cli/axelard_query_gov_proposals.md
diff --git a/docs/cli/axelard_query_gov_proposer.md b/docs/cli/axelard_query_gov_proposer.md
diff --git a/docs/cli/axelard_query_gov_tally.md b/docs/cli/axelard_query_gov_tally.md
diff --git a/docs/cli/axelard_query_gov_vote.md b/docs/cli/axelard_query_gov_vote.md
diff --git a/docs/cli/axelard_query_gov_votes.md b/docs/cli/axelard_query_gov_votes.md
diff --git a/docs/cli/axelard_query_ibc-transfer_denom-hash.md b/docs/cli/axelard_query_ibc-transfer_denom-hash.md
diff --git a/docs/cli/axelard_query_ibc-transfer_denom-trace.md b/docs/cli/axelard_query_ibc-transfer_denom-trace.md
diff --git a/docs/cli/axelard_query_ibc-transfer_denom-traces.md b/docs/cli/axelard_query_ibc-transfer_denom-traces.md
diff --git a/docs/cli/axelard_query_ibc-transfer_escrow-address.md b/docs/cli/axelard_query_ibc-transfer_escrow-address.md
diff --git a/docs/cli/axelard_query_ibc-transfer_params.md b/docs/cli/axelard_query_ibc-transfer_params.md