docs: fixup envvar output
authorErik Faye-Lund <erik.faye-lund@collabora.com>
Thu, 2 Jul 2020 12:15:57 +0000 (14:15 +0200)
committerMarge Bot <eric+marge@anholt.net>
Tue, 7 Jul 2020 10:22:08 +0000 (10:22 +0000)
Sphinx 2.x has changed how this works, and some of this whitespace now
gets stripped as a result. So let's instead actual whitespace as separate
text-nodes instead.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706>

docs/_exts/formatting.py

index bc50c98051ccccd764dd0ee247899c283a749f7b..cc6c471f117566c185559a2d8d495419648eb989 100644 (file)
@@ -9,10 +9,12 @@ import sphinx.addnodes
 def parse_envvar(env, sig, signode):
     envvar, t, default = sig.split(" ", 2)
     envvar = envvar.strip().upper()
-    t = " Type: %s" % t.strip(" <>").lower()
-    default = " Default: %s" % default.strip(" ()")
+    t = "Type: %s" % t.strip(" <>").lower()
+    default = "Default: %s" % default.strip(" ()")
     signode += sphinx.addnodes.desc_name(envvar, envvar)
+    signode += docutils.nodes.Text(' ')
     signode += sphinx.addnodes.desc_type(t, t)
+    signode += docutils.nodes.Text(', ')
     signode += sphinx.addnodes.desc_annotation(default, default)
     return envvar