Skip to content

Commit

Permalink
Merge pull request #912 from sphinx-contrib/add-doc-warning-to-publis…
Browse files Browse the repository at this point in the history
…h-debug-cfg

doc: add warning about enabling publish-debug opt and sharing
  • Loading branch information
jdknight authored Mar 3, 2024
2 parents 189b093 + 440f34b commit 5dd439a
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1382,6 +1382,13 @@ Advanced publishing configuration

Switched from boolean to string for setting new debugging options.

.. warning::

Enabling certain debugging options may reveal information such as
authentication details in printed logs. Take this into consideration
when sharing any debug logs with other users or enabling this option
when part of a CI/CD script, job or workflow.

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
Expand Down

0 comments on commit 5dd439a

Please sign in to comment.