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

documenting.rst: Using autodoc

Browse source 
Switch `autocmd` to use the `seealso` admonition for referencing source file location instead of `note`.
This commit is contained in:
Krystine Sherwin 2025-11-22 12:56:30 +13:00
parent 5318df784a
commit dc8198561a
No known key found for this signature in database
3 changed files with 66 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/util/cmd_documenter.py
View file

@ -394,7 +394,7 @@ class YosysCmdDocumenter(YosysCmdGroupDocumenter):
if self.get_sourcename() != 'unknown':
self.add_line('\n', source_name)
self.add_line(f'.. note:: Help text automatically generated from :file:`{source_name}:{source_line}`', source_name)
self.add_line(f'.. seealso:: Help text automatically generated from :file:`{source_name}:{source_line}`', source_name)
# add additional content (e.g. from document), if present
if more_content: