Skip to content

Adjust rst warning directive to a confluence note type#1170

Merged
jdknight merged 5 commits into
mainfrom
adjust-warning-node-to-note-macro
Jan 24, 2026
Merged

Adjust rst warning directive to a confluence note type#1170
jdknight merged 5 commits into
mainfrom
adjust-warning-node-to-note-macro

Conversation

@jdknight

Copy link
Copy Markdown
Member

Warning are subjectively a yellow-hinted admonition. While we mapped a reStructuredText warning to a Confluence warning, a Confluence warning type is red-hinted. This commit adjusts the mapping to have warning nodes to now create Confluence note macros.

This change also introduces an undocumented confluence_adv_admonition_overrides configuration, allowing users to override the mapping between admonition types to Confluence macro types.

Warning are subjectively a yellow-hinted admonition. While we mapped a
reStructuredText warning to a Confluence warning, a Confluence warning
type is red-hinted. This commit adjusts the mapping to have warning
nodes to now create Confluence note macros.

Signed-off-by: James Knight <git@jdknight.me>
Allow advanced users to tailor the mapping of admonition type to
Confluence macros used.

Signed-off-by: James Knight <git@jdknight.me>
Signed-off-by: James Knight <git@jdknight.me>
An update [1] to adjust warning directives to map to Confluence note
types was made. Updating the unit test to handle this.

[1]: dbc3660

Signed-off-by: James Knight <git@jdknight.me>
Signed-off-by: James Knight <git@jdknight.me>
@jdknight jdknight added this to the 3.1 milestone Jan 24, 2026
@jdknight jdknight merged commit 06ec395 into main Jan 24, 2026
27 checks passed
@jdknight jdknight deleted the adjust-warning-node-to-note-macro branch January 24, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant