Merge pull request #47 from regisb/regisb/featuretoggle-warnings

robrap · web-flow · commit 12dc1a7be9eb · 2020-08-25T14:33:14.000-04:00
[BD-21] Add support for warnings in the `featuretoggles` Sphinx extension
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -11,6 +11,11 @@ Change Log
 
 .. There should always be an "Unreleased" section for changes pending release.
 
+[0.5.1] - 2020-08-25
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for warnings in the ``featuretoggles`` Sphinx extension
+
 [0.5.0] - 2020-08-06
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/code_annotations/__init__.py b/code_annotations/__init__.py
@@ -2,4 +2,4 @@
 Extensible tools for parsing annotations in codebases.
 """
 
-__version__ = '0.5.0'
+__version__ = '0.5.1'
diff --git a/code_annotations/config_and_tools/sphinx/extensions/featuretoggles.py b/code_annotations/config_and_tools/sphinx/extensions/featuretoggles.py
@@ -115,6 +115,10 @@ def iter_nodes(self):
                 ),
             )
             yield nodes.paragraph(text=toggle.get(".. toggle_description:", ""))
+            if toggle.get(".. toggle_warnings:") not in (None, "None", "n/a", "N/A"):
+                yield nodes.warning(
+                    "", nodes.paragraph("", toggle[".. toggle_warnings:"])
+                )
 
 
 def quote_value(value):

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,10 @@ def iter_nodes(self):`
`115`	`115`	`),`
`116`	`116`	`)`
`117`	`117`	`yield nodes.paragraph(text=toggle.get(".. toggle_description:", ""))`
	`118`	`+ if toggle.get(".. toggle_warnings:") not in (None, "None", "n/a", "N/A"):`
	`119`	`+ yield nodes.warning(`
	`120`	`+ "", nodes.paragraph("", toggle[".. toggle_warnings:"])`
	`121`	`+ )`
`118`	`122`
`119`	`123`
`120`	`124`	`def quote_value(value):`