Group CLI options into sections in help docs

Cargo.toml

@@ -3,6 +3,7 @@ resolver = "2"
 members = [
     "cmd/stellar-cli",
     "cmd/soroban-cli",
+    "cmd/doc-gen",
     "cmd/crates/*",
     "cmd/crates/soroban-test/tests/fixtures/test-wasms/*",
     "cmd/crates/soroban-test/tests/fixtures/hello",

Makefile

@@ -44,7 +44,7 @@ build-test-wasms:
 build-test: build-test-wasms install
 
 docs:
-	cargo run --bin doc-gen
+	cargo run --package doc-gen
 	./node_modules/.bin/prettier --write --log-level warn FULL_HELP_DOCS.md
 
 test: build-test

cmd/doc-gen/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "doc-gen"
+description = "Stellar CLI generator of markdown help documentation"
+homepage = "https://github.com/stellar/stellar-cli"
+repository = "https://github.com/stellar/stellar-cli"
+authors = ["Stellar Development Foundation <[email protected]>"]
+license = "Apache-2.0"
+readme = "README.md"
+version.workspace = true
+edition = "2021"
+rust-version.workspace = true
+publish = false
+
+[dependencies]
+soroban-cli = { workspace = true }
+# clap-markdown from https://github.com/ConnorGray/clap-markdown/pull/48
+clap-markdown = { version = "0.1.5", git = "https://github.com/ConnorGray/clap-markdown", rev = "42956b342cef3325d9060fc43995d595e7c8aa66" }

cmd/doc-gen/README.md

@@ -0,0 +1,21 @@
+# Stellar CLI Documentation Generator
+
+A generator for the help documentation using clap-markdown.
+
+## Usage
+
+Run the following command from the workspace root.
+
+```
+cargo run --package doc-gen
+```
+
+The command will update the file `FULL_HELP_DOCS.md` located in the root of the workspace.
+
+Typically this command is not run directly, but in the root `Makefile` the `docs` target will run this command in conjunction with formatting the markdown.
+
+So typically run this command via make:
+
+```
+make docs
+```

cmd/soroban-cli/Cargo.toml

@@ -24,10 +24,6 @@ path = "src/bin/soroban.rs"
 pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ version }-{ target }{ archive-suffix }"
 bin-dir = "{ bin }{ binary-ext }"
 
-[[bin]]
-name = "doc-gen"
-path = "src/bin/doc-gen.rs"
-
 [lib]
 name = "soroban_cli"
 path = "src/lib.rs"
@@ -133,7 +129,6 @@ whoami = "1.5.2"
 serde_with = "3.11.0"
 rustc_version = "0.4.1"
 prettytable = "0.10.0"
-clap-markdown = "0.1.5"
 
 [build-dependencies]
 crate-git-revision = "0.0.6"

deny.toml

@@ -258,7 +258,10 @@ unknown-git = "deny"
 # if not specified. If it is specified but empty, no registries are allowed.
 allow-registry = ["https://github.com/rust-lang/crates.io-index"]
 # List of URLs for allowed Git repositories
-allow-git = []
+allow-git = [
+  # Only used by the unpublished doc-gen crate, temporarily until PR is merged: https://github.com/ConnorGray/clap-markdown/pull/48
+  "https://github.com/ConnorGray/clap-markdown?rev=42956b342cef3325d9060fc43995d595e7c8aa66",
+]
 
 [sources.allow-org]
 # 1 or more github.com organizations to allow git sources for