mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-10-31 03:32:29 +00:00
Code Activity

cmdref.py: Support autoref for 'help <cmd>'

Browse source
This commit is contained in:
Krystine Sherwin 2024-05-27 16:32:45 +12:00
parent be5572ca0e
commit 6aceb6a297
No known key found for this signature in database
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/util/cmdref.py
View file

@ -430,9 +430,12 @@ class CellDomain(CommandDomain):
TagIndex TagIndex
} }
def autoref(name, rawtext, text, lineno, inliner: Inliner, def autoref(name, rawtext: str, text: str, lineno, inliner: Inliner,
options=None, content=None): options=None, content=None):
role = 'cell:ref' if text[0] == '$' else 'cmd:ref' role = 'cell:ref' if text[0] == '$' else 'cmd:ref'
if text.startswith("help ") and text.count(' ') == 1:
_, cmd = text.split(' ', 1)
text = f'{text} <{cmd}>'
return inliner.interpreted(rawtext, text, role, lineno) return inliner.interpreted(rawtext, text, role, lineno)
def setup(app: Sphinx): def setup(app: Sphinx):