Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
11 changes: 0 additions & 11 deletions cmd/axelard/genDocs.sh

This file was deleted.

2 changes: 0 additions & 2 deletions cmd/axelard/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/axelard_debug_addr.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_debug_pubkey.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_debug_raw-bytes.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_gentx.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_migrate.md

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

1 change: 1 addition & 0 deletions docs/cli/axelard_query.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_auth_module-account.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_bank_balances.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_bank_denom-metadata.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_bank_total.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_distribution_commission.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_distribution_community-pool.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_distribution_rewards.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_distribution_slashes.md

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

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_evidence.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_feegrant_grant.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_feegrant_grants-by-grantee.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_feegrant_grants-by-granter.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_gov_deposit.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_gov_deposits.md

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

6 changes: 3 additions & 3 deletions docs/cli/axelard_query_gov_param.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_gov_params.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_gov_proposal.md

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

8 changes: 4 additions & 4 deletions docs/cli/axelard_query_gov_proposals.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_gov_proposer.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_gov_tally.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_gov_vote.md

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

4 changes: 2 additions & 2 deletions docs/cli/axelard_query_gov_votes.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_ibc-transfer_denom-hash.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_ibc-transfer_denom-trace.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_ibc-transfer_denom-traces.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_ibc-transfer_escrow-address.md

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

2 changes: 1 addition & 1 deletion docs/cli/axelard_query_ibc-transfer_params.md

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

Loading
Loading