riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

cmd links use title text

This commit is contained in:
Krystine Sherwin 2023-08-08 12:19:13 +12:00
parent 9fcf353734
commit f8333e52f7
No known key found for this signature in database
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/util/cmdref.py
View File

@ -52,12 +52,15 @@ class CommandNode(ObjectDescription):
signode['ids'].append('cmd' + '-' + sig) signode['ids'].append('cmd' + '-' + sig)
if 'noindex' not in self.options: if 'noindex' not in self.options:
name = "{}.{}.{}".format('cmd', type(self).__name__, sig) name = "{}.{}.{}".format('cmd', type(self).__name__, sig)
tmap = self.env.domaindata['cmd']['obj2tag'] tagmap = self.env.domaindata['cmd']['obj2tag']
tmap[name] = list(self.options.get('tags', '').split(' ')) tagmap[name] = list(self.options.get('tags', '').split(' '))
title = self.options.get('title')
titlemap = self.env.domaindata['cmd']['obj2title']
titlemap[name] = title
objs = self.env.domaindata['cmd']['objects'] objs = self.env.domaindata['cmd']['objects']
objs.append((name, objs.append((name,
sig, sig,
self.options.get('title'), title,
self.env.docname, self.env.docname,
'cmd' + '-' + sig, 'cmd' + '-' + sig,
0)) 0))
@ -193,8 +196,9 @@ class CommandDomain(Domain):
} }
initial_data = { initial_data = {
'objects': [], # object list 'objects': [], # object list
'obj2tag': {}, # name -> object 'obj2tag': {}, # name -> tags
'obj2title': {}, # name -> title
} }
def get_full_qualified_name(self, node): def get_full_qualified_name(self, node):
@ -210,16 +214,18 @@ class CommandDomain(Domain):
def resolve_xref(self, env, fromdocname, builder, typ, def resolve_xref(self, env, fromdocname, builder, typ,
target, node, contnode): target, node, contnode):
match = [(docname, anchor) match = [(docname, anchor, name)
for name, sig, typ, docname, anchor, prio for name, sig, typ, docname, anchor, prio
in self.get_objects() if sig == target] in self.get_objects() if sig == target]
if len(match) > 0: if match:
todocname = match[0][0] todocname = match[0][0]
targ = match[0][1] targ = match[0][1]
qual_name = match[0][2]
title = self.data['obj2title'].get(qual_name, targ)
return make_refnode(builder,fromdocname,todocname, return make_refnode(builder,fromdocname,todocname,
targ, contnode, targ) targ, contnode, title)
else: else:
print("Awww, found nothing") print("Awww, found nothing")
return None return None