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

fix anchor text transformation

develop
myk002 2022-09-23 12:51:50 -07:00
parent 98b6ad4954
commit 4ae1b7fb74
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -110,6 +110,14 @@ def check_missing_keybinds():
logger.warning('Undocumented keybindings for command: %s', missing_command) logger.warning('Undocumented keybindings for command: %s', missing_command)
_anchor_pattern = re.compile(r'^\d+')
def to_anchor(name: str) -> str:
name = name.lower()
name = name.replace('/', '-')
name = re.sub(_anchor_pattern, '', name)
return name
class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription): class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription):
has_content = False has_content = False
required_arguments = 0 required_arguments = 0
@ -129,7 +137,7 @@ class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription):
def add_index_entries(self, name) -> None: def add_index_entries(self, name) -> None:
docname = self.env.docname docname = self.env.docname
anchor = self.get_tool_name_from_docname().replace('/', '-') anchor = to_anchor(self.get_tool_name_from_docname())
tags = self.env.domaindata['tag-repo']['doctags'][docname] tags = self.env.domaindata['tag-repo']['doctags'][docname]
indexdata = (name, self.options.get('summary', ''), '', docname, anchor, 0) indexdata = (name, self.options.get('summary', ''), '', docname, anchor, 0)
self.env.domaindata['all']['objects'].append(indexdata) self.env.domaindata['all']['objects'].append(indexdata)
@ -293,7 +301,7 @@ def update_index_titles(app):
if app.builder.format == 'html': if app.builder.format == 'html':
index.localname = '"%s" tag index<h4>%s</h4>' % (index.shortname, index.localname) index.localname = '"%s" tag index<h4>%s</h4>' % (index.shortname, index.localname)
else: else:
index.localname = '%s tag index - %s' % (index.shortname, index.localname) index.localname = '"%s" tag index - %s' % (index.shortname, index.localname)
def register(app): def register(app):
app.add_directive('dfhack-tool', DFHackToolDirective) app.add_directive('dfhack-tool', DFHackToolDirective)