feat(docs): improve command line

update option descriptions according to current code
jazzband · Jan 7, 2025 · 22900fd · 22900fd
1 parent d846d70
commit 22900fd
Showing 1 changed file with 62 additions and 33 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -313,64 +313,93 @@ any other variable, e.g.:
 Command Line
 ^^^^^^^^^^^^
 
-Constance settings can be get/set on the command line with the manage command `constance`
+Constance settings can be get/set on the command line with the manage command :command:`constance`.
 
 Available options are:
 
-list - output all values in a tab-separated format::
+.. program:: constance
 
-    $ ./manage.py constance list
-    THE_ANSWER 42
-    SITE_NAME  My Title
+.. option:: list
 
-get KEY - output a single values::
+   list all Constance keys and their values
 
-    $ ./manage.py constance get THE_ANSWER
-    42
+   .. code-block:: console
 
-set KEY VALUE - set a single value::
+      $ ./manage.py constance list
+      THE_ANSWER 42
+      SITE_NAME  My Title
 
-    $ ./manage.py constance set SITE_NAME "Another Title"
+.. option:: get <KEY>
 
-If the value contains spaces it should be wrapped in quotes.
+   get the value of a Constance key
 
-.. note::  Set values are validated as per in admin, an error will be raised if validation fails:
+   .. code-block:: console
 
-E.g., given this config as per the example app::
+      $ ./manage.py constance get THE_ANSWER
+      42
 
-   CONSTANCE_CONFIG = {
-       ...
-       'DATE_ESTABLISHED': (date(1972, 11, 30), "the shop's first opening"),
-   }
+.. option:: set <KEY> <VALUE>
 
-Setting an invalid date will fail as follow::
+   set the value of a Constance key
 
-   $ ./manage.py constance set DATE_ESTABLISHED '1999-12-00'
-   CommandError: Enter a valid date.
+   .. code-block:: console
 
+      $ ./manage.py constance set SITE_NAME "Another Title"
 
-.. note::  If the admin field is a `MultiValueField`, then the separate field values need to be provided as separate arguments.
-E.g., a datetime using `SplitDateTimeField`::
+   If the value contains spaces it should be wrapped in quotes.
 
-   CONSTANCE_CONFIG = {
-       'DATETIME_VALUE': (datetime(2010, 8, 23, 11, 29, 24), 'time of the first commit'),
-   }
+   .. note:: Set values are validated as per in admin, an error will be raised if validation fails:
 
-Then this works (and the quotes are optional)::
+   E.g., given this config as per the example app:
 
-   ./manage.py constance set DATETIME_VALUE '2011-09-24' '12:30:25'
+   .. code-block:: python
 
-This doesn't work::
+      CONSTANCE_CONFIG = {
+          ...
+          'DATE_ESTABLISHED': (date(1972, 11, 30), "the shop's first opening"),
+      }
 
-   ./manage.py constance set DATETIME_VALUE '2011-09-24 12:30:25'
-   CommandError: Enter a list of values.
+   Setting an invalid date will fail as follow:
 
+   .. code-block:: console
 
-remove_stale_keys - delete all stale records in database::
+      $ ./manage.py constance set DATE_ESTABLISHED '1999-12-00'
+      CommandError: Enter a valid date.
 
-    $ ./manage.py constance remove_stale_keys
 
-Record is considered stale if it exists in database but absent in config
+   .. note:: If the admin field is a :class:`MultiValueField`, then the separate field values need to be provided as separate arguments.
+
+   E.g., a datetime using :class:`SplitDateTimeField`:
+
+   .. code-block:: python
+
+      CONSTANCE_CONFIG = {
+          'DATETIME_VALUE': (datetime(2010, 8, 23, 11, 29, 24), 'time of the first commit'),
+      }
+
+   Then this works (and the quotes are optional):
+
+   .. code-block:: console
+
+      ./manage.py constance set DATETIME_VALUE '2011-09-24' '12:30:25'
+
+   This doesn't work:
+
+   .. code-block:: console
+
+      ./manage.py constance set DATETIME_VALUE '2011-09-24 12:30:25'
+      CommandError: Enter a list of values.
+
+
+.. option:: remove_stale_keys
+
+   delete all Constance keys and their values if they are not in settings.CONSTANCE_CONFIG (stale keys)
+
+   .. code-block:: console
+
+      $ ./manage.py constance remove_stale_keys
+
+   Record is considered stale if it exists in database but absent in config.
 
 Editing
 -------