Skip to content

[BD-21] Add support for warnings in the featuretoggles Sphinx extension #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robrap merged 1 commit into from
Aug 25, 2020
Merged

[BD-21] Add support for warnings in the featuretoggles Sphinx extension #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion code_annotations/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Extensible tools for parsing annotations in codebases.
"""

__version__ = '0.5.0'
__version__ = '0.5.1'
4 changes: 4 additions & 0 deletions code_annotations/config_and_tools/sphinx/extensions/featuretoggles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down