mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-07 14:43:23 +00:00
Code Activity

cmdref: Add cmd titles

Browse source 
Display subheadings for each command.
Remove now redundant toc entry for `yosys> help <cmd>` line.
This commit is contained in:
Krystine Sherwin 2025-03-21 10:26:11 +13:00
parent 68cb02d9f3
commit a3125ce892
No known key found for this signature in database
2 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/util/cmdref.py
View file

@ -33,7 +33,7 @@ class TocNode(ObjectDescription):
signode['ids'].append(idx) signode['ids'].append(idx)
def _object_hierarchy_parts(self, sig_node: addnodes.desc_signature) -> tuple[str, ...]: def _object_hierarchy_parts(self, sig_node: addnodes.desc_signature) -> tuple[str, ...]:
if 'fullname' not in sig_node: if 'tocname' not in sig_node:
return () return ()
modname = sig_node.get('module') modname = sig_node.get('module')

4
docs/util/newcmdref.py
View file

@ -322,6 +322,10 @@ class YosysCmdDocumenter(YosysCmdGroupDocumenter):
source_name = self.object.source_file source_name = self.object.source_file
source_line = self.object.source_line source_line = self.object.source_line
title = f'{self.object.name} - {self.object.title}'
self.add_line(title, source_name, source_line)
self.add_line('#' * len(title), source_name, source_line)
# cmd definition # cmd definition
self.add_line(f'.. {domain}:{directive}:: {sig}', source_name, source_line) self.add_line(f'.. {domain}:{directive}:: {sig}', source_name, source_line)
if self.object.title: if self.object.title: