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.

Sign up for GitHub

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

Jump to bottom

[WIP] Add command reference #2238

Draft
wants to merge 10 commits into
base: develop
Choose a base branch
from
+350 −6
Draft

[WIP] Add command reference #2238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ef2c236
Use sphinxcontrib-typer and install all dependencies for docs environ…
craddm Oct 16, 2024
c9dda0e
use sphinxcontrib-typer extension and configure sphinx appropriately
craddm Oct 16, 2024
6e778ad
Add command reference top-level section
craddm Oct 16, 2024
7f3b96e
add all commands to reference
craddm Oct 16, 2024
1827b4d
Add blank line
craddm Oct 16, 2024
0dcf83d
Merge branch 'alan-turing-institute:develop' into add-command-reference
craddm Oct 16, 2024
db05b5c
use consistent format for main dsh command
craddm Oct 16, 2024
15d30c5
use better title
craddm Oct 16, 2024
68562c6
update requirements for docs
craddm Oct 16, 2024
1a34235
Fix linting
craddm Oct 16, 2024
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
284 changes: 280 additions & 4 deletions .hatch/requirements-docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,163 @@
#
# This file is autogenerated by hatch-pip-compile with Python 3.12
#
# - appdirs==1.4.4
# - azure-core==1.31.0
# - azure-identity==1.19.0
# - azure-keyvault-certificates==4.8.0
# - azure-keyvault-keys==4.9.0
# - azure-keyvault-secrets==4.8.0
# - azure-mgmt-compute==33.0.0
# - azure-mgmt-containerinstance==10.1.0
# - azure-mgmt-dns==8.1.0
# - azure-mgmt-keyvault==10.3.1
# - azure-mgmt-msi==7.0.0
# - azure-mgmt-rdbms==10.1.0
# - azure-mgmt-resource==23.1.1
# - azure-mgmt-storage==21.2.1
# - azure-storage-blob==12.23.1
# - azure-storage-file-datalake==12.17.0
# - azure-storage-file-share==12.19.0
# - chevron==0.14.0
# - cryptography==43.0.1
# - fqdn==1.5.1
# - psycopg[binary]==3.2.3
# - pulumi-azure-native==2.66.0
# - pulumi-azuread==6.0.0
# - pulumi-random==4.16.6
# - pulumi==3.136.1
# - pydantic==2.9.2
# - pyjwt[crypto]==2.9.0
# - pytz==2024.2
# - pyyaml==6.0.2
# - rich==13.9.2
# - simple-acme-dns==3.1.0
# - typer==0.12.5
# - websocket-client==1.8.0
# - emoji==2.14.0
# - myst-parser==4.0.0
# - pydata-sphinx-theme==0.15.4
# - 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.31.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.8.0
# via hatch.envs.docs
azure-keyvault-keys==4.9.0
# via hatch.envs.docs
azure-keyvault-secrets==4.8.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.4.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.1.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.1.1
# via hatch.envs.docs
azure-mgmt-storage==21.2.1
# via hatch.envs.docs
azure-storage-blob==12.23.1
# via
# hatch.envs.docs
# azure-storage-file-datalake
azure-storage-file-datalake==12.17.0
# via hatch.envs.docs
azure-storage-file-share==12.19.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==43.0.1
# via
# hatch.envs.docs
# acme
# azure-identity
# azure-keyvault-keys
# azure-storage-blob
# azure-storage-file-share
# josepy
# msal
# pyjwt
# pyopenssl
debugpy==1.8.7
# via pulumi
dill==0.3.9
# via pulumi
dnspython==2.6.1
# via simple-acme-dns
docutils==0.21.2
# via
# myst-parser
Expand All @@ -30,41 +166,154 @@ 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.1
# via jinja2
mdit-py-plugins==0.4.2
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
msal==1.31.0
# 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.1
# via
# pydata-sphinx-theme
# 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.2.3
# via hatch.envs.docs
psycopg-binary==3.2.3
# via psycopg
pulumi==3.136.1
# via
# hatch.envs.docs
# pulumi-azure-native
# pulumi-azuread
# pulumi-random
pulumi-azure-native==2.66.0
# via hatch.envs.docs
pulumi-azuread==6.0.0
# via hatch.envs.docs
pulumi-random==4.16.6
# via hatch.envs.docs
pycparser==2.22
# via cffi
pydantic==2.9.2
# via hatch.envs.docs
pydantic-core==2.23.4
# via pydantic
pydata-sphinx-theme==0.15.4
# via hatch.envs.docs
pygments==2.18.0
# via
# accessible-pygments
# pydata-sphinx-theme
# rich
# sphinx
pyjwt==2.9.0
# via
# hatch.envs.docs
# msal
pyopenssl==24.2.1
# via
# acme
# josepy
pyrfc3339==1.1
# via acme
pytz==2024.2
# via
# hatch.envs.docs
# acme
# pyrfc3339
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.2
# 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.1.0
# via hatch.envs.docs
six==1.16.0
# via
# azure-core
# pulumi
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.6
Expand All @@ -75,6 +324,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
Expand All @@ -89,10 +339,36 @@ 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.12.5
# via hatch.envs.docs
typer-slim==0.12.5
# 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-keyvault
# 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.28.3
# via simple-acme-dns
websocket-client==1.8.0
# via hatch.envs.docs
wheel==0.44.0
# via sphinx-togglebutton

Expand Down
5 changes: 4 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import datetime
import emoji

import sys
import os
sys.path.insert(0, os.path.abspath(os.path.join("..", "..")))

# -- Project information -----------------------------------------------------

Expand Down Expand Up @@ -55,6 +57,7 @@
extensions = [
"myst_parser",
"sphinx_togglebutton",
"sphinxcontrib.typer",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
Loading
Loading