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

Docs: Proto doc_string approach for cmd help

Browse source 
Add `doc_string` field to `Pass` constructor
Add `docs/util/newcmdref.py` to contain command domain
Update `docs/util/cmdref.py` with `cmd:usage` and `cmd:optiongroup` for describing commands.
Functional, but WIP.
This commit is contained in:
Krystine Sherwin 2025-07-21 10:33:31 +12:00
parent 5ce097ed3d
commit 714790c70b
No known key found for this signature in database
5 changed files with 635 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/conf.py
View file

@ -112,6 +112,8 @@ extensions.append('util.cmdref')
extensions.append('sphinx.ext.autodoc')
extensions.append('util.cellref')
cells_json = Path(__file__).parent / 'generated' / 'cells.json'
extensions.append('util.newcmdref')
cmds_json = Path(__file__).parent / 'generated' / 'cmds.json'
from sphinx.application import Sphinx
def setup(app: Sphinx) -> None: