Escape special (html) chars in section names (#4350)
To correctly generate the configuration reference html output,
escape special html characters like '<' and '>' in section names.
diff --git a/src/docs/ext/configdomain.py b/src/docs/ext/configdomain.py
index 66ed532..983ac44 100644
--- a/src/docs/ext/configdomain.py
+++ b/src/docs/ext/configdomain.py
@@ -15,6 +15,7 @@
from sphinx.domains import Domain, ObjType, Index
from sphinx.directives import ObjectDescription
from sphinx.util.nodes import make_refnode
+import html
class ConfigObject(ObjectDescription):
@@ -62,7 +63,7 @@
def generate(self, docnames=None):
content = dict(
- (name, [(name, 1, info[0], name, "", "", info[1])])
+ (html.escape(name), [(name, 1, info[0], name, "", "", info[1])])
for name, info in self.domain.data["section"].items()
)
@@ -70,7 +71,7 @@
for idx, info in sorted(options.items()):
path, descr = info
section, name = idx.split("/", 1)
- content[section].append(
+ content[html.escape(section)].append(
(name, 2, path, "%s/%s" % (section, name), "", "", descr)
)
