Merge pull request #370 from jumpstarter-dev/programout

mangelajo · web-flow · commit c7d55b716ec6 · 2025-03-21T22:59:50.000+01:00
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,6 +26,7 @@
 
 extensions = [
     "sphinxcontrib.mermaid",
+    "sphinxcontrib.programoutput",
     "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
diff --git a/docs/source/getting-started/setup-exporter-client.md b/docs/source/getting-started/setup-exporter-client.md
@@ -30,21 +30,11 @@ To create an exporter and save the config locally, run the following command:
 ```bash
 # Creates an exporter called "testing" and saves the config
 $ jmp admin create exporter testing --save
+```
 
-# Usage for jmp admin create exporter
-$ jmp admin create exporter
- --help
-Usage: jmp admin create exporter [OPTIONS] [NAME]
-
-  Create an exporter object in the Kubernetes cluster
+## Usage for jmp admin create exporter
 
-Options:
-  -s, --save             Save the config file for the created exporter.
-  -o, --out FILE         Specify an output file for the exporter config.
-  -n, --namespace TEXT   Kubernetes namespace to use
-  --kubeconfig FILENAME  path to the kubeconfig file
-  --context TEXT         Kubernetes context to use
-  --help                 Show this message and exit.
+```{command-output} jmp admin create exporter --help
 ```
 
 ### Edit the Exporter Config
@@ -99,24 +89,11 @@ To connect to the new exporter, a client must be created. We can also use the
 ```bash
 # This will create a client called "hello", allow unsafe drivers, and save the config
 $ jmp admin create client hello --save --unsafe
+```
 
-# Usage for jmp admin create client
-jmp admin create client --help
-Usage: jmp admin create client [OPTIONS] [NAME]
-
-  Create a client object in the Kubernetes cluster
+## Usage for jmp admin create client
 
-Options:
-  -s, --save             Save the config file for the created client.
-  -a, --allow TEXT       A comma-separated list of driver client packages to
-                         load.
-  --unsafe               Should all driver client packages be allowed to load
-                         (UNSAFE!).
-  -o, --out FILE         Specify an output file for the client config.
-  -n, --namespace TEXT   Kubernetes namespace to use
-  --kubeconfig FILENAME  path to the kubeconfig file
-  --context TEXT         Kubernetes context to use
-  --help                 Show this message and exit.
+```{command-output} jmp admin create client --help
 ```
 
 ## Connect to the Exporter
@@ -130,33 +107,11 @@ Python API.
 ```bash
 # Spawn a shell using the "hello" client
 $ jmp shell --client hello --selector example.com/board=foo
+```
 
-# Usage for jmp shell
-$ jmp shell --help
-Usage: jmp shell [OPTIONS]
-
-  Spawns a shell connecting to a local or remote exporter
+## Usage for jmp shell
 
-Options:
-  --exporter-config PATH  Path of exporter config
-  --exporter TEXT         Alias of exporter config
-  --client-config PATH    Path to client config
-  --client TEXT           Alias of client config
-  --lease TEXT
-  -l, --selector TEXT     Selector (label query) to filter on, supports '=',
-                          '==', and '!=' (e.g. -l key1=value1,key2=value2).
-                          Matching objects must satisfy all of the specified
-                          label constraints.
-  --duration DURATION     Accepted duration formats:
-
-                          PnYnMnDTnHnMnS - ISO 8601 duration format
-                          HH:MM:SS - time in hours, minutes, seconds
-                          D days, HH:MM:SS - time prefixed by X days
-                          D d, HH:MM:SS - time prefixed by X d
-
-                          See https://docs.rs/speedate/latest/speedate/ for
-                          details  [default: (00:30:00)]
-  --help                  Show this message and exit.
+```{command-output} jmp shell --help
 ```
 
 Once a lease is acquired, we can interact with the drivers hosted by the exporter
diff --git a/docs/source/installation/service/kind-helm.md b/docs/source/installation/service/kind-helm.md
@@ -75,29 +75,11 @@ If you do not have Helm installed, please [install the latest release](https://h
 ```
 # Install Jumpstarter with default options
 $ jmp admin install
+```
+
+## Options provided by the Jumpstarter CLI
 
-# Options provided by the Jumpstarter CLI
-$ jmp admin install --help
-Usage: jmp admin install [OPTIONS]
-
-  Install the Jumpstarter service in a Kubernetes cluster
-
-Options:
-  --helm TEXT                 Path or name of a helm executable
-  --name TEXT                 The name of the chart installation
-  -c, --chart TEXT            The URL of a Jumpstarter helm chart to install
-  -n, --namespace TEXT        Namespace to install Jumpstarter components in
-  -i, --ip TEXT               IP address of your host machine
-  -b, --basedomain TEXT       Base domain of the Jumpstarter service
-  -g, --grpc-endpoint TEXT    The gRPC endpoint to use for the Jumpstarter API
-  -r, --router-endpoint TEXT  The gRPC endpoint to use for the router
-  --nodeport                  Use Nodeport routing (recommended)
-  --ingress                   Use a Kubernetes ingress
-  --route                     Use an OpenShift route
-  -v, --version TEXT          The version of the service to install
-  --kubeconfig FILENAME       path to the kubeconfig file
-  --context TEXT              Kubernetes context to use
-  --help                      Show this message and exit.
+```{command-output} jmp admin install --help
 ```
 
 ### Install Jumpstarter with Helm
diff --git a/docs/source/installation/service/minikube-helm.md b/docs/source/installation/service/minikube-helm.md
@@ -37,29 +37,11 @@ If you do not have Helm installed, please [install the latest release](https://h
 ```
 # Install Jumpstarter with default options
 $ jmp admin install --ip $(minikube ip)
+```
+
+## Options provided by the Jumpstarter CLI
 
-# Options provided by the Jumpstarter CLI
-$ jmp admin install --help
-Usage: jmp admin install [OPTIONS]
-
-  Install the Jumpstarter service in a Kubernetes cluster
-
-Options:
-  --helm TEXT                 Path or name of a helm executable
-  --name TEXT                 The name of the chart installation
-  -c, --chart TEXT            The URL of a Jumpstarter helm chart to install
-  -n, --namespace TEXT        Namespace to install Jumpstarter components in
-  -i, --ip TEXT               IP address of your host machine
-  -b, --basedomain TEXT       Base domain of the Jumpstarter service
-  -g, --grpc-endpoint TEXT    The gRPC endpoint to use for the Jumpstarter API
-  -r, --router-endpoint TEXT  The gRPC endpoint to use for the router
-  --nodeport                  Use Nodeport routing (recommended)
-  --ingress                   Use a Kubernetes ingress
-  --route                     Use an OpenShift route
-  -v, --version TEXT          The version of the service to install
-  --kubeconfig FILENAME       path to the kubeconfig file
-  --context TEXT              Kubernetes context to use
-  --help                      Show this message and exit.
+```{command-output} jmp admin install --help
 ```
 
 ### Install Jumpstarter with Helm
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,6 +43,7 @@ docs = [
     "sphinx-click>=6.0.0",
     "sphinx-substitution-extensions>=2024.10.17",
     "requests>=2.32.3",
+    "sphinxcontrib-programoutput>=0.18",
 ]
 dev = [
     "ruff==0.9.2",
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ docs = [`
`43`	`43`	`"sphinx-click>=6.0.0",`
`44`	`44`	`"sphinx-substitution-extensions>=2024.10.17",`
`45`	`45`	`"requests>=2.32.3",`
	`46`	`+ "sphinxcontrib-programoutput>=0.18",`
`46`	`47`	`]`
`47`	`48`	`dev = [`
`48`	`49`	`"ruff==0.9.2",`