doc: document html macro configuration

Adding the documentation for the `confluence_html_macro` configuration entry. Signed-off-by: James Knight <[email protected]>
sphinx-contrib · Aug 24, 2024 · 7edabcf · 7edabcf
1 parent d2a8175
commit 7edabcf
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/doc/configuration.rst b/doc/configuration.rst
@@ -1909,6 +1909,23 @@ Advanced processing configuration
 
         confluence_file_suffix = '.conf'
 
+.. |confluence_html_macro| replace:: ``confluence_html_macro``
+.. _confluence_html_macro:
+
+.. confval:: confluence_html_macro
+
+    .. versionadded:: 2.7
+
+    This option will configure the HTML macro type for the ``confluence_html``
+    :ref:`directive <confluence_html>`. By default, the ``html`` macro
+    identifier is set.
+
+    .. code-block:: python
+
+        confluence_html_macro = 'html'
+
+    See also the :ref:`HTML directive <confluence_html>`.
+
 .. index:: Jira; Configuring Jira servers
 
 .. _confluence_jira_servers: