cleanup publish debug options (format/presentation)

Updating the configuration handling of publish debugging options to
promote the uses of dashes of underscores (e.g. `headers-and-data` over
`headers_and_data`). Both values are still accepted, but the dash
variant will be the value shown in documentation.

This commit also adjusts the configuration check to explicitly list
supported options. The previous use of populating values from the
enumeration does not work for all desired entries. Best to list the
explicit values we want to inform a user on.

Signed-off-by: James Knight <[email protected]>

Author: jdknight

sphinxcontrib/confluencebuilder/config/checks.py

@@ -533,15 +533,13 @@ def conf_translate(value):
     # ##################################################################
 
     # confluence_publish_debug
-    opts = PublishDebug._member_names_  # pylint: disable=no-member
     try:
         validator.conf('confluence_publish_debug').bool()  # deprecated
     except ConfluenceConfigError:
         try:
             validator.conf('confluence_publish_debug').enum(PublishDebug)
         except ConfluenceConfigError as ex:
-            opts_str = '\n - '.join(opts)
-            raise ConfluencePublishDebugConfigError(ex, opts_str) from ex
+            raise ConfluencePublishDebugConfigError(ex) from ex
 
     # ##################################################################
 

sphinxcontrib/confluencebuilder/config/defaults.py

@@ -107,7 +107,8 @@ def apply_defaults(builder):
         if publish_debug is True:
             conf.confluence_publish_debug = PublishDebug.urllib3
         elif isinstance(publish_debug, str) and publish_debug:
-            conf.confluence_publish_debug = PublishDebug[publish_debug.lower()]
+            raw_debug = publish_debug.replace('-', '_').lower()
+            conf.confluence_publish_debug = PublishDebug[raw_debug]
         else:
             conf.confluence_publish_debug = PublishDebug.none
 

sphinxcontrib/confluencebuilder/config/exceptions.py

@@ -229,15 +229,18 @@ def __init__(self):
 
 
 class ConfluencePublishDebugConfigError(ConfluenceConfigError):
-    def __init__(self, msg, opts):
+    def __init__(self, msg):
         super().__init__(f'''\
 {msg}
 
 The option 'confluence_publish_debug' has been configured to enable publish
 debugging. Accepted values include:
 
  - all
- - {opts}
+ - deprecated
+ - headers
+ - headers-and-data
+ - urllib3
 ''')
 
 

sphinxcontrib/confluencebuilder/config/validation.py

@@ -218,7 +218,7 @@ def enum(self, etype):
 
         if value is not None and not isinstance(value, etype):
             try:
-                value = etype[value.lower()]
+                value = etype[value.replace('-', '_').lower()]
             except (AttributeError, KeyError) as ex:
                 msg = f'{self.key} is not an enumeration ({etype.__name__})'
                 raise ConfluenceConfigError(msg) from ex