diff options
author | Erik Faye-Lund <erik.faye-lund@collabora.com> | 2023-03-17 15:02:46 +0100 |
---|---|---|
committer | Marge Bot <emma+marge@anholt.net> | 2023-04-26 22:45:41 +0000 |
commit | e64dae9441c8fbf99c55fccc78e852f954fd432e (patch) | |
tree | 7674789404cb11cf2b4b0f6a734e6ce4553680ff /docs | |
parent | f72033bb707046ef5966cb55cbf9bd9fb7bb038f (diff) | |
download | mesa-e64dae9441c8fbf99c55fccc78e852f954fd432e.tar.gz |
docs: translate admonitions into bootstrap alerts
Sphinx and Bootstraps disagree on what these are called. Let's try to
bridge that gap, by rewriting things a bit.
Reviewed-by: Eric Engestrom <eric@igalia.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8399>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/_exts/bootstrap.py | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/_exts/bootstrap.py b/docs/_exts/bootstrap.py index 555bd6bba64..9050d54adb8 100644 --- a/docs/_exts/bootstrap.py +++ b/docs/_exts/bootstrap.py @@ -36,6 +36,7 @@ from docutils import nodes import sphinx from sphinx.ext.autosummary import autosummary_table +from sphinx.locale import admonitionlabels import types @@ -50,6 +51,28 @@ class BootstrapHTML5TranslatorMixin: kwargs["ARIA-LEVEL"] = "2" return super().starttag(*args, **kwargs) + def visit_admonition(self, node, name: str = '') -> None: + admonitionclasses = { + 'attention': 'alert-primary', + 'caution': 'alert-secondary', + 'danger': 'alert-danger', + 'error': 'alert-danger', + 'hint': 'alert-secondary', + 'important': 'alert-primary', + 'note': 'alert-info', + 'seealso': 'alert-info', + 'tip': 'alert-info', + 'warning': 'alert-warning', + } + + self.body.append(self.starttag( + node, 'div', CLASS=('alert ' + admonitionclasses[name]))) + if name: + self.body.append( + self.starttag(node, 'div', '', CLASS='h5')) + self.body.append(str(admonitionlabels[name])) + self.body.append('</div>') + def visit_table(self, node): # init the attributes atts = {} |