Merge pull request #2238 from craddm/add-command-reference

Add command reference to documentation

.hatch/requirements-docs.txt

@@ -1,27 +1,163 @@
 #
 # This file is autogenerated by hatch-pip-compile with Python 3.12
 #
+# - appdirs==1.4.4
+# - azure-core==1.32.0
+# - azure-identity==1.19.0
+# - azure-keyvault-certificates==4.9.0
+# - azure-keyvault-keys==4.10.0
+# - azure-keyvault-secrets==4.9.0
+# - azure-mgmt-compute==33.0.0
+# - azure-mgmt-containerinstance==10.1.0
+# - azure-mgmt-dns==8.2.0
+# - azure-mgmt-keyvault==10.3.1
+# - azure-mgmt-msi==7.0.0
+# - azure-mgmt-rdbms==10.1.0
+# - azure-mgmt-resource==23.2.0
+# - azure-mgmt-storage==21.2.1
+# - azure-storage-blob==12.24.0
+# - azure-storage-file-datalake==12.18.0
+# - azure-storage-file-share==12.20.0
+# - chevron==0.14.0
+# - cryptography==44.0.0
+# - fqdn==1.5.1
+# - psycopg[binary]==3.1.19
+# - pulumi-azure-native==2.74.0
+# - pulumi-azuread==6.0.1
+# - pulumi-random==4.16.7
+# - pulumi==3.142.0
+# - pydantic==2.10.2
+# - pyjwt[crypto]==2.10.1
+# - pytz==2024.2
+# - pyyaml==6.0.2
+# - rich==13.9.4
+# - simple-acme-dns==3.2.0
+# - typer==0.14.0
+# - websocket-client==1.8.0
 # - emoji==2.14.0
 # - myst-parser==4.0.0
 # - pydata-sphinx-theme==0.16.0
 # - sphinx-togglebutton==0.3.2
 # - sphinx==8.1.3
+# - sphinxcontrib-typer==0.5.1
 #
 
 accessible-pygments==0.0.5
     # via pydata-sphinx-theme
+acme==2.10.0
+    # via simple-acme-dns
 alabaster==1.0.0
     # via sphinx
+annotated-types==0.7.0
+    # via pydantic
+appdirs==1.4.4
+    # via hatch.envs.docs
+arpeggio==2.0.2
+    # via parver
+attrs==24.2.0
+    # via parver
+azure-common==1.1.28
+    # via
+    #   azure-mgmt-compute
+    #   azure-mgmt-containerinstance
+    #   azure-mgmt-dns
+    #   azure-mgmt-keyvault
+    #   azure-mgmt-msi
+    #   azure-mgmt-rdbms
+    #   azure-mgmt-resource
+    #   azure-mgmt-storage
+azure-core==1.32.0
+    # via
+    #   hatch.envs.docs
+    #   azure-identity
+    #   azure-keyvault-certificates
+    #   azure-keyvault-keys
+    #   azure-keyvault-secrets
+    #   azure-mgmt-core
+    #   azure-storage-blob
+    #   azure-storage-file-datalake
+    #   azure-storage-file-share
+    #   msrest
+azure-identity==1.19.0
+    # via hatch.envs.docs
+azure-keyvault-certificates==4.9.0
+    # via hatch.envs.docs
+azure-keyvault-keys==4.10.0
+    # via hatch.envs.docs
+azure-keyvault-secrets==4.9.0
+    # via hatch.envs.docs
+azure-mgmt-compute==33.0.0
+    # via hatch.envs.docs
+azure-mgmt-containerinstance==10.1.0
+    # via hatch.envs.docs
+azure-mgmt-core==1.5.0
+    # via
+    #   azure-mgmt-compute
+    #   azure-mgmt-containerinstance
+    #   azure-mgmt-dns
+    #   azure-mgmt-keyvault
+    #   azure-mgmt-msi
+    #   azure-mgmt-rdbms
+    #   azure-mgmt-resource
+    #   azure-mgmt-storage
+azure-mgmt-dns==8.2.0
+    # via hatch.envs.docs
+azure-mgmt-keyvault==10.3.1
+    # via hatch.envs.docs
+azure-mgmt-msi==7.0.0
+    # via hatch.envs.docs
+azure-mgmt-rdbms==10.1.0
+    # via hatch.envs.docs
+azure-mgmt-resource==23.2.0
+    # via hatch.envs.docs
+azure-mgmt-storage==21.2.1
+    # via hatch.envs.docs
+azure-storage-blob==12.24.0
+    # via
+    #   hatch.envs.docs
+    #   azure-storage-file-datalake
+azure-storage-file-datalake==12.18.0
+    # via hatch.envs.docs
+azure-storage-file-share==12.20.0
+    # via hatch.envs.docs
 babel==2.16.0
     # via
     #   pydata-sphinx-theme
     #   sphinx
 beautifulsoup4==4.12.3
     # via pydata-sphinx-theme
 certifi==2024.8.30
-    # via requests
+    # via
+    #   msrest
+    #   requests
+cffi==1.17.1
+    # via cryptography
 charset-normalizer==3.4.0
     # via requests
+chevron==0.14.0
+    # via hatch.envs.docs
+click==8.1.7
+    # via
+    #   typer
+    #   typer-slim
+cryptography==44.0.0
+    # via
+    #   hatch.envs.docs
+    #   acme
+    #   azure-identity
+    #   azure-keyvault-keys
+    #   azure-storage-blob
+    #   azure-storage-file-share
+    #   josepy
+    #   msal
+    #   pyjwt
+    #   pyopenssl
+debugpy==1.8.9
+    # via pulumi
+dill==0.3.9
+    # via pulumi
+dnspython==2.7.0
+    # via simple-acme-dns
 docutils==0.21.2
     # via
     #   myst-parser
@@ -30,39 +166,151 @@ docutils==0.21.2
     #   sphinx-togglebutton
 emoji==2.14.0
     # via hatch.envs.docs
+fqdn==1.5.1
+    # via hatch.envs.docs
+grpcio==1.66.2
+    # via pulumi
 idna==3.10
     # via requests
 imagesize==1.4.1
     # via sphinx
+isodate==0.7.2
+    # via
+    #   azure-keyvault-certificates
+    #   azure-keyvault-keys
+    #   azure-keyvault-secrets
+    #   azure-mgmt-compute
+    #   azure-mgmt-containerinstance
+    #   azure-mgmt-dns
+    #   azure-mgmt-keyvault
+    #   azure-mgmt-resource
+    #   azure-mgmt-storage
+    #   azure-storage-blob
+    #   azure-storage-file-datalake
+    #   azure-storage-file-share
+    #   msrest
 jinja2==3.1.4
     # via
     #   myst-parser
     #   sphinx
+josepy==1.14.0
+    # via acme
 markdown-it-py==3.0.0
     # via
     #   mdit-py-plugins
     #   myst-parser
+    #   rich
 markupsafe==3.0.2
     # via jinja2
 mdit-py-plugins==0.4.2
     # via myst-parser
 mdurl==0.1.2
     # via markdown-it-py
+msal==1.31.1
+    # via
+    #   azure-identity
+    #   msal-extensions
+msal-extensions==1.2.0
+    # via azure-identity
+msrest==0.7.1
+    # via
+    #   azure-mgmt-msi
+    #   azure-mgmt-rdbms
 myst-parser==4.0.0
     # via hatch.envs.docs
+oauthlib==3.2.2
+    # via requests-oauthlib
 packaging==24.2
     # via sphinx
+parver==0.5
+    # via
+    #   pulumi-azure-native
+    #   pulumi-azuread
+    #   pulumi-random
+portalocker==2.10.1
+    # via msal-extensions
+protobuf==4.25.5
+    # via pulumi
+psycopg==3.1.19
+    # via hatch.envs.docs
+psycopg-binary==3.1.19
+    # via psycopg
+pulumi==3.142.0
+    # via
+    #   hatch.envs.docs
+    #   pulumi-azure-native
+    #   pulumi-azuread
+    #   pulumi-random
+pulumi-azure-native==2.74.0
+    # via hatch.envs.docs
+pulumi-azuread==6.0.1
+    # via hatch.envs.docs
+pulumi-random==4.16.7
+    # via hatch.envs.docs
+pycparser==2.22
+    # via cffi
+pydantic==2.10.2
+    # via hatch.envs.docs
+pydantic-core==2.27.1
+    # via pydantic
 pydata-sphinx-theme==0.16.0
     # via hatch.envs.docs
 pygments==2.18.0
     # via
     #   accessible-pygments
     #   pydata-sphinx-theme
+    #   rich
     #   sphinx
+pyjwt==2.10.1
+    # via
+    #   hatch.envs.docs
+    #   msal
+pyopenssl==24.3.0
+    # via
+    #   acme
+    #   josepy
+pyrfc3339==2.0.1
+    # via acme
+pytz==2024.2
+    # via
+    #   hatch.envs.docs
+    #   acme
 pyyaml==6.0.2
-    # via myst-parser
+    # via
+    #   hatch.envs.docs
+    #   myst-parser
+    #   pulumi
 requests==2.32.3
-    # via sphinx
+    # via
+    #   acme
+    #   azure-core
+    #   msal
+    #   msrest
+    #   requests-oauthlib
+    #   sphinx
+requests-oauthlib==2.0.0
+    # via msrest
+rich==13.9.4
+    # via
+    #   hatch.envs.docs
+    #   typer
+    #   typer-slim
+semver==2.13.0
+    # via
+    #   pulumi
+    #   pulumi-azure-native
+    #   pulumi-azuread
+    #   pulumi-random
+shellingham==1.5.4
+    # via
+    #   typer
+    #   typer-slim
+simple-acme-dns==3.2.0
+    # via hatch.envs.docs
+six==1.16.0
+    # via
+    #   azure-core
+    #   pulumi
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.6
@@ -73,6 +321,7 @@ sphinx==8.1.3
     #   myst-parser
     #   pydata-sphinx-theme
     #   sphinx-togglebutton
+    #   sphinxcontrib-typer
 sphinx-togglebutton==0.3.2
     # via hatch.envs.docs
 sphinxcontrib-applehelp==2.0.0
@@ -87,10 +336,38 @@ sphinxcontrib-qthelp==2.0.0
     # via sphinx
 sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
+sphinxcontrib-typer==0.5.1
+    # via hatch.envs.docs
+typer==0.14.0
+    # via hatch.envs.docs
+typer-slim==0.14.0
+    # via sphinxcontrib-typer
 typing-extensions==4.12.2
-    # via pydata-sphinx-theme
+    # via
+    #   azure-core
+    #   azure-identity
+    #   azure-keyvault-certificates
+    #   azure-keyvault-keys
+    #   azure-keyvault-secrets
+    #   azure-mgmt-compute
+    #   azure-mgmt-dns
+    #   azure-mgmt-keyvault
+    #   azure-mgmt-resource
+    #   azure-storage-blob
+    #   azure-storage-file-datalake
+    #   azure-storage-file-share
+    #   psycopg
+    #   pydantic
+    #   pydantic-core
+    #   pydata-sphinx-theme
+    #   typer
+    #   typer-slim
 urllib3==2.2.3
     # via requests
+validators==0.34.0
+    # via simple-acme-dns
+websocket-client==1.8.0
+    # via hatch.envs.docs
 wheel==0.45.1
     # via sphinx-togglebutton
 

.readthedocs.yaml

@@ -16,6 +16,8 @@ formats:
 python:
   install:
     - requirements: .hatch/requirements-docs.txt
+    - method: pip
+      path: .
 
 sphinx:
   configuration: docs/source/conf.py

docs/source/conf.py

@@ -55,6 +55,7 @@
 extensions = [
     "myst_parser",
     "sphinx_togglebutton",
+    "sphinxcontrib.typer",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/deployment/deploy_shm.md

@@ -54,7 +54,7 @@ Before deploying the Safe Haven Management (SHM) infrastructure you need to deci
   Use the short name without spaces, _e.g._ **uksouth** not **UK South**
   :::
 
-Once you've decided on these, run the following command: [approx 5 minutes]:
+Once you've decided on these, run the {typer}`dsh-shm-deploy` command: [approx 5 minutes]:
 
 :::{code} shell
 $ dsh shm deploy --entra-tenant-id YOUR_ENTRA_TENANT_ID \