doc: document CLI

doc/commands.rst

@@ -0,0 +1,6 @@
+Command Line Interface
+======================
+
+.. click:: canaille.commands:cli
+   :prog: canaille
+   :nested: full

doc/conf.py

@@ -35,6 +35,7 @@ extensions = [
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_enum_extend",
+    "sphinx_click",
     "sphinx_issues",
     "sphinx_sitemap",
     "sphinxcontrib.autodoc_pydantic",

doc/index.rst

@@ -45,10 +45,11 @@ Table of contents
    deployment
    databases
    configuration
+   commands
    troubleshooting
-   contributing
    reference
    specifications
+   contributing
    changelog
 
 Indices and tables

poetry.lock

@@ -2004,6 +2004,22 @@ docs = ["sphinxcontrib-websupport"]
 lint = ["flake8 (>=3.5.0)", "importlib_metadata", "mypy (==1.9.0)", "pytest (>=6.0)", "ruff (==0.3.7)", "sphinx-lint", "tomli", "types-docutils", "types-requests"]
 test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=6.0)", "setuptools (>=67.0)"]
 
+[[package]]
+name = "sphinx-click"
+version = "5.1.0"
+description = "Sphinx extension that automatically documents click applications"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "sphinx-click-5.1.0.tar.gz", hash = "sha256:6812c2db62d3fae71a4addbe5a8a0a16c97eb491f3cd63fe34b4ed7e07236f33"},
+    {file = "sphinx_click-5.1.0-py3-none-any.whl", hash = "sha256:ae97557a4e9ec646045089326c3b90e026c58a45e083b8f35f17d5d6558d08a0"},
+]
+
+[package.dependencies]
+click = ">=7.0"
+docutils = "*"
+sphinx = ">=2.0"
+
 [[package]]
 name = "sphinx-enum-extend"
 version = "0.1.3"
@@ -2568,4 +2584,4 @@ sql = ["passlib", "sqlalchemy", "sqlalchemy-json", "sqlalchemy-utils"]
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.9"
-content-hash = "1892b091d5f953c51dade5874af91b4615655e96a3a0fef5a7cede857ddd5b31"
+content-hash = "6a790691e8619fbfd76d73ffb92d5140e75b6fe2d31bf20db23077f7e5f18bc4"

pyproject.toml

@@ -77,6 +77,7 @@ sphinx = "^7.0.0"
 sphinx-enum-extend = "^0.1.3"
 sphinx-sitemap = "^2.5.1"
 sphinx-issues = "^4.0.0"
+sphinx-click = "^5.1.0"
 
 [tool.poetry.group.dev.dependencies]
 coverage = {version = "*", extras=["toml"]}