From 50f0d1137215d4505c837a732fe6548f8bf64c55 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 23 Sep 2022 13:19:13 -0700 Subject: [PATCH] include tool desc in the index for all formats --- docs/sphinx_extensions/dfhack/tool_docs.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/sphinx_extensions/dfhack/tool_docs.py b/docs/sphinx_extensions/dfhack/tool_docs.py index 62569a4d1..18532c9d5 100644 --- a/docs/sphinx_extensions/dfhack/tool_docs.py +++ b/docs/sphinx_extensions/dfhack/tool_docs.py @@ -260,8 +260,11 @@ def tag_index_generate(self, docnames: Optional[Iterable[str]] = None) -> Tuple[ content = defaultdict(list) for name, desc, _, docname, anchor, _ in self.domain.data['objects']: first_letter = name[0].lower() + extra, descr = desc, '' + if self.domain.env.app.builder.format == 'html': + extra, descr = '', desc content[first_letter].append( - IndexEntry(name, 0, docname, anchor, '', '', desc)) + IndexEntry(name, 0, docname, anchor, extra, '', descr)) return (sorted(content.items()), False) def register_index(app, tag, title):