doc: improve command docstrings

Author: azmeuk

doc/conf.py

@@ -56,21 +56,9 @@
     ],
 }
 
-# -- Options for HTMLHelp output ------------------------------------------
-
-htmlhelp_basename = "scim_clidoc"
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {}
-latex_documents = [
-    (master_doc, "scim_cli.tex", "scim_cli Documentation", "Yaal", "manual")
-]
-
 # -- Options for manual page output ---------------------------------------
 
-man_pages = [(master_doc, "scim_cli", "scim_cli Documentation", [author], 1)]
+man_pages = [(master_doc, "scim-cli", "scim-cli Documentation", [author], 1)]
 
 # -- Options for Texinfo output -------------------------------------------
 

pyproject.toml

@@ -105,7 +105,8 @@ commands =
 [testenv:doc]
 commands =
     poetry install --with doc --without dev
-    poetry run sphinx-build doc build/sphinx/html
+    poetry run sphinx-build --builder html doc build/sphinx/html
+    poetry run sphinx-build --builder man doc build/sphinx/html
 
 [testenv:coverage]
 commands =

scim_cli/__init__.py

@@ -27,7 +27,11 @@ def cli(ctx, url):
 def get(ctx):
     """Perform a SCIM GET request.
 
-    https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1
+    Data passed in JSON format to stdin is sent as request arguments::
+
+        echo '{"foo": "bar"}' | scim https://scim.example get
+
+    Details on: https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1
     """
 
     response = requests.get(
@@ -44,6 +48,10 @@ def get(ctx):
 def post(ctx):
     """Perform a SCIM POST request.
 
+    Data passed in JSON format to stdin is sent as request payload::
+
+        echo '{"foo": "bar"}' | scim https://scim.example post
+
     https://www.rfc-editor.org/rfc/rfc7644#section-3.3
     """
 
@@ -61,6 +69,10 @@ def post(ctx):
 def put(ctx):
     """Perform a SCIM PUT request.
 
+    Data passed in JSON format to stdin is sent as request payload::
+
+        echo '{"foo": "bar"}' | scim https://scim.example put
+
     https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1
     """
 
@@ -78,6 +90,10 @@ def put(ctx):
 def patch(ctx):
     """Perform a SCIM PATCH request.
 
+    Data passed in JSON format to stdin is sent as request payload::
+
+        echo '{"foo": "bar"}' | scim https://scim.example patch
+
     https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2
     """
 
@@ -95,6 +111,10 @@ def patch(ctx):
 def delete(ctx):
     """Perform a SCIM DELETE request.
 
+    Data passed in JSON format to stdin is sent as request payload::
+
+        echo '{"foo": "bar"}' | scim https://scim.example delete
+
     https://www.rfc-editor.org/rfc/rfc7644#section-3.6
     """