add tag description to the tag index page

myk002 · myk002 · commit 5869ba64c8b7 · 2022-09-23T10:21:53.000-07:00
this is a terrible hack that only works because sphinx doesn't sanitize
its input for the html builder. we set the title to

  '%s&lt;h4&gt;%s&lt;/h4&gt;' % (tag, desc)

so the final html looks like &lt;h1&gt;adventure&lt;h4&gt;...&lt;/h4&gt;&lt;/h1&gt;

this may not play nice with the pdf builder..
diff --git a/docs/sphinx_extensions/dfhack/tool_docs.py b/docs/sphinx_extensions/dfhack/tool_docs.py
@@ -265,7 +265,7 @@ def init_tag_indices(app):
                 tag, desc = tag_tuple[0], tag_tuple[1]
                 topidx.write(('- `{name} <{name}-tag-index>`\n').format(name=tag))
                 topidx.write(('    {desc}\n').format(desc=desc))
-                register_index(app, tag, '"%s" tag index' % tag)
+                register_index(app, tag, '%s<h4>%s</h4>' % (tag, desc))
 
 
 def register(app):
