3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-07-21 11:52:07 +00:00

Docs: Group commands

Removes group parsing from command ref domain, instead relying on a 'groups' object in the cmds.json file.
`docs/source/cmd` is no longer ignored or cleaned.
This commit is contained in:
Krystine Sherwin 2025-03-21 10:26:10 +13:00
parent 620dcd8a38
commit 431cb2d1b9
No known key found for this signature in database
21 changed files with 113 additions and 26 deletions

View file

@ -0,0 +1,5 @@
backends
------------------
.. autocmdgroup:: backends
:members:

View file

@ -0,0 +1,5 @@
formal
------------------
.. autocmdgroup:: formal
:members:

View file

@ -0,0 +1,5 @@
frontends
------------------
.. autocmdgroup:: frontends
:members:

View file

@ -0,0 +1,5 @@
kernel
------------------
.. autocmdgroup:: kernel
:members:

View file

@ -0,0 +1,7 @@
Other commands
==============
Unknown source location
.. autocmdgroup:: unknown
:members:

View file

@ -0,0 +1,5 @@
passes/cmds
------------------
.. autocmdgroup:: passes/cmds
:members:

View file

@ -0,0 +1,5 @@
passes/equiv
------------------
.. autocmdgroup:: passes/equiv
:members:

View file

@ -0,0 +1,5 @@
passes/fsm
------------------
.. autocmdgroup:: passes/fsm
:members:

View file

@ -0,0 +1,5 @@
passes/hierarchy
------------------
.. autocmdgroup:: passes/hierarchy
:members:

View file

@ -0,0 +1,5 @@
passes/memory
------------------
.. autocmdgroup:: passes/memory
:members:

View file

@ -0,0 +1,5 @@
passes/opt
------------------
.. autocmdgroup:: passes/opt
:members:

View file

@ -0,0 +1,5 @@
passes/pmgen
------------------
.. autocmdgroup:: passes/pmgen
:members:

View file

@ -0,0 +1,5 @@
passes/proc
------------------
.. autocmdgroup:: passes/proc
:members:

View file

@ -0,0 +1,5 @@
passes/sat
------------------
.. autocmdgroup:: passes/sat
:members:

View file

@ -0,0 +1,5 @@
passes/techmap
------------------
.. autocmdgroup:: passes/techmap
:members:

View file

@ -0,0 +1,5 @@
passes/tests
------------------
.. autocmdgroup:: passes/tests
:members:

View file

@ -0,0 +1,5 @@
techlibs
------------------
.. autocmdgroup:: techlibs
:members:

View file

@ -8,9 +8,15 @@ Command line reference
:start-at: Usage
.. toctree::
:caption: Command reference
:maxdepth: 1
:glob:
:caption: Command reference
:maxdepth: 2
:glob:
/appendix/env_vars
/cmd/*
/appendix/env_vars
/cmd/index_backends
/cmd/index_frontends
/cmd/index_kernel
/cmd/index_formal
/cmd/index_passes*
/cmd/index_techlibs
/cmd/index_other