Render dfhack-tool as admonition

Getting a section header integrated is complicated, so might as well emulate Mediawiki with a box-like element instead
2022-08-06 16:59:45 -04:00 · 2022-08-06 16:59:45 -04:00 · bb2ca0cc16
parent de5f4d3566
commit bb2ca0cc16
2 changed files with 12 additions and 2 deletions
--- a/docs/sphinx_extensions/dfhack/tool_docs.py
+++ b/docs/sphinx_extensions/dfhack/tool_docs.py
@ -32,8 +32,13 @@ class DFHackToolDirective(sphinx.directives.ObjectDescription):
        tag_nodes.pop()

        return [
-            nodes.section('', nodes.title(text=tool_name), ids=[tool_name]),
-            nodes.paragraph('', '', *tag_nodes),
+            nodes.admonition('', *[
+                nodes.paragraph('', '', *[
+                    nodes.strong('', 'Tool: '),
+                    nodes.inline('', tool_name),
+                ]),
+                nodes.paragraph('', '', *tag_nodes),
+            ], classes=['dfhack-tool-summary']),
        ]


--- a/docs/styles/dfhack.css
+++ b/docs/styles/dfhack.css
@ -60,3 +60,8 @@ div.body {
 span.pre {
    overflow-wrap: break-word;
 }
+
+.dfhack-tool-summary p {
+    margin-top: 0;
+    margin-bottom: 0.5em;
+}