Merge pull request #1170 from sphinx-contrib/adjust-warning-node-to-note-macro

Adjust rst warning directive to a confluence note type

Author: jdknight

sphinxcontrib/confluencebuilder/__init__.py

@@ -301,6 +301,8 @@ def setup(app):
     cm.add_conf_bool('confluence_mermaid_html_macro', 'confluence')
 
     # (configuration - undocumented)
+    # Allow overriding which admonition type is used
+    cm.add_conf('confluence_adv_admonition_overrides', 'confluence')
     # Enablement for bulk archiving of packages (for premium environments).
     cm.add_conf_bool('confluence_adv_bulk_archiving')
     # Disable any delays when publishing property updates on Cloud

sphinxcontrib/confluencebuilder/config/checks.py

@@ -82,6 +82,12 @@ def validate_configuration(builder):
 
     # ##################################################################
 
+    # confluence_adv_admonition_overrides
+    validator.conf('confluence_adv_admonition_overrides') \
+             .dict_str_str()
+
+    # ##################################################################
+
     # confluence_adv_bulk_archiving
     validator.conf('confluence_adv_bulk_archiving') \
              .bool()

sphinxcontrib/confluencebuilder/storage/translator.py

@@ -1011,6 +1011,10 @@ def depart_attribution(self, node):
     def _visit_admonition(self, node, atype, title=None, logo=True):
         collapsible = node.get('collapsible', False)
 
+        ato = self.builder.config.confluence_adv_admonition_overrides
+        if ato:
+            atype = ato.get(node.__class__.__name__, atype)
+
         self.body.append(self.start_ac_macro(node, atype))
         if title and not collapsible:
             self.body.append(self.build_ac_param(node, 'title', title))
@@ -1138,7 +1142,7 @@ def depart_admonition(self, node):
     depart_tip = _depart_admonition
     visit_todo_node = _visit_todo_node
     depart_todo_node = depart_admonition
-    visit_warning = _visit_warning
+    visit_warning = _visit_note
     depart_warning = _depart_admonition
 
     # ------

tests/sample-sets/admonitions/conf.py

@@ -0,0 +1,3 @@
+extensions = [
+    'sphinxcontrib.confluencebuilder',
+]

tests/sample-sets/admonitions/index.rst

@@ -0,0 +1,42 @@
+Admonitions
+###########
+
+.. admonition:: my-title
+
+    admonition content
+
+.. attention::
+
+    attention content
+
+.. caution::
+
+    caution content
+
+.. danger::
+
+    danger content
+
+.. error::
+
+    error content
+
+.. hint::
+
+    hint content
+
+.. important::
+
+    important content
+
+.. note::
+
+    note content
+
+.. tip::
+
+    tip content
+
+.. warning::
+
+    warning content

tests/sample-sets/admonitions/tox.ini

@@ -0,0 +1,11 @@
+[tox]
+package_root={toxinidir}{/}..{/}..{/}..
+
+[testenv]
+commands =
+    {envpython} -m tests.test_sample {posargs}
+setenv =
+    PYTHONDONTWRITEBYTECODE=1
+    TOX_INI_DIR={toxinidir}
+passenv = *
+use_develop = true

tests/unit-tests/test_rst_admonitions.py

@@ -27,17 +27,17 @@ def test_storage_rst_admonitions_default(self):
             self._verify_storage_tags(data, 'important', 'warning')
             self._verify_storage_tags(data, 'note', 'info')
             self._verify_storage_tags(data, 'tip', 'tip')
-            self._verify_storage_tags(data, 'warning', 'warning')
+            self._verify_storage_tags(data, 'warning', 'note')
 
             macro = self._verify_storage_tags(data, 'admonition', 'info')
             title_param = macro.find('ac:parameter', {'ac:name': 'title'})
             self.assertIsNotNone(title_param,
-                'admonition is missing a title paramater')
+                'admonition is missing a title parameter')
             self.assertEqual(title_param.text, 'my-title',
                 'admonition title value does not match expected')
             icon_param = macro.find('ac:parameter', {'ac:name': 'icon'})
             self.assertIsNotNone(icon_param,
-                'admonition is missing a icon paramater')
+                'admonition is missing a icon parameter')
             self.assertEqual(icon_param.text, 'false',
                 'admonition icon value is not disabled')
 
@@ -55,7 +55,7 @@ def test_storage_rst_admonitions_v2(self):
             self._verify_storage_tags(data, 'important', 'warning')
             self._verify_storage_tags(data, 'note', 'info')
             self._verify_storage_tags(data, 'tip', 'tip')
-            self._verify_storage_tags(data, 'warning', 'warning')
+            self._verify_storage_tags(data, 'warning', 'note')
 
             # v2 admonition is stored in a adf panel node
             # - adf nodes are wrapped in extension tags