MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove now-unused dfhack-keybind role

develop
lethosor 2022-08-17 22:52:10 -04:00
parent 7e0581204d
commit a4e70cf3e1
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
conf.py
Unescape Escape View File

@ -118,12 +118,6 @@ def write_tool_docs():
for k in DOC_ALL_DIRS: for k in DOC_ALL_DIRS:
header = ':orphan:\n' header = ':orphan:\n'
label = ('.. _{name}:\n\n').format(name=k[0]) label = ('.. _{name}:\n\n').format(name=k[0])
# TODO: can we autogenerate the :dfhack-keybind: line? it would go beneath
# the tool header, which is currently in the middle of the included file.
# should we remove those headers from the doc files and just generate them
# here? That might be easier. But then where will the tags go? It would
# look better if they were above the keybinds, but then we'd be in the
# same situation.
include = ('.. include:: /{path}\n\n').format(path=k[1]) include = ('.. include:: /{path}\n\n').format(path=k[1])
# TODO: generate a footer with links to tools that share at least one # TODO: generate a footer with links to tools that share at least one
# tag with this tool. Just the tool names, strung across the bottom of # tag with this tool. Just the tool names, strung across the bottom of

8
docs/sphinx_extensions/dfhack/tool_docs.py
Unescape Escape View File

@ -89,13 +89,6 @@ def check_missing_keybinds():
logger.warning('Undocumented keybindings for command: %s', missing_command) logger.warning('Undocumented keybindings for command: %s', missing_command)
# pylint:disable=unused-argument,dangerous-default-value,too-many-arguments
def dfhack_keybind_role(role, rawtext, text, lineno, inliner,
options={}, content=[]):
"""Custom role parser for DFHack default keybinds."""
return render_dfhack_keybind(text), []
class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription): class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription):
has_content = False has_content = False
required_arguments = 0 required_arguments = 0
@ -169,7 +162,6 @@ class DFHackCommandDirective(DFHackToolDirectiveBase):
def register(app): def register(app):
app.add_directive('dfhack-tool', DFHackToolDirective) app.add_directive('dfhack-tool', DFHackToolDirective)
app.add_directive('dfhack-command', DFHackCommandDirective) app.add_directive('dfhack-command', DFHackCommandDirective)
app.add_role('dfhack-keybind', dfhack_keybind_role)
_KEYBINDS.update(scan_all_keybinds(os.path.join(dfhack.util.DFHACK_ROOT, 'data', 'init'))) _KEYBINDS.update(scan_all_keybinds(os.path.join(dfhack.util.DFHACK_ROOT, 'data', 'init')))