Skip to content

Commit

Permalink
doc: update new confluence_publish_debug str-options
Browse files Browse the repository at this point in the history
With updates to `confluence_publish_debug` to accept string values for
various debugging modes, updating the documentation to reflect the new
values which can be set.

Signed-off-by: James Knight <james.d.knight@live.com>
  • Loading branch information
jdknight committed Feb 25, 2024
1 parent d67d20a commit 27e1438
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1378,15 +1378,28 @@ Advanced publishing configuration
.. confval:: confluence_publish_debug

.. versionadded:: 1.8
.. versionchanged:: 2.5

A boolean value to whether or not to print debug requests made to a
Confluence instance. This can be helpful for users attempting to debug
their connection to a Confluence instance. By default, this option is
disabled with a value of ``False``.
Switched from boolean to string for setting new debugging options.

Configures the ability to enable certain debugging messages for requests
made to a Confluence instance. This can be helpful for users attempting
to debug their connection to a Confluence instance. By default, no
debugging is enabled.

Available options are as follows:

- ``all``: Enable all debugging options.
- ``deprecated``: Log warnings when a deprecated API call is used
(*for development purposes*).
- ``headers``: Log requests and responses, including their headers.
- ``urllib3``: Enable urllib3 library debugging messages.

An example debugging configuration is as follows:

.. code-block:: python
confluence_publish_debug = True
confluence_publish_debug = 'urllib3'
.. confval:: confluence_publish_delay

Expand Down

0 comments on commit 27e1438

Please sign in to comment.