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:
parent
620dcd8a38
commit
431cb2d1b9
21 changed files with 113 additions and 26 deletions
5
docs/source/cmd/index_backends.rst
Normal file
5
docs/source/cmd/index_backends.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
backends
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: backends
|
||||
:members:
|
5
docs/source/cmd/index_formal.rst
Normal file
5
docs/source/cmd/index_formal.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
formal
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: formal
|
||||
:members:
|
5
docs/source/cmd/index_frontends.rst
Normal file
5
docs/source/cmd/index_frontends.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
frontends
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: frontends
|
||||
:members:
|
5
docs/source/cmd/index_kernel.rst
Normal file
5
docs/source/cmd/index_kernel.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
kernel
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: kernel
|
||||
:members:
|
7
docs/source/cmd/index_other.rst
Normal file
7
docs/source/cmd/index_other.rst
Normal file
|
@ -0,0 +1,7 @@
|
|||
Other commands
|
||||
==============
|
||||
|
||||
Unknown source location
|
||||
|
||||
.. autocmdgroup:: unknown
|
||||
:members:
|
5
docs/source/cmd/index_passes_cmds.rst
Normal file
5
docs/source/cmd/index_passes_cmds.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/cmds
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/cmds
|
||||
:members:
|
5
docs/source/cmd/index_passes_equiv.rst
Normal file
5
docs/source/cmd/index_passes_equiv.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/equiv
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/equiv
|
||||
:members:
|
5
docs/source/cmd/index_passes_fsm.rst
Normal file
5
docs/source/cmd/index_passes_fsm.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/fsm
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/fsm
|
||||
:members:
|
5
docs/source/cmd/index_passes_hierarchy.rst
Normal file
5
docs/source/cmd/index_passes_hierarchy.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/hierarchy
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/hierarchy
|
||||
:members:
|
5
docs/source/cmd/index_passes_memory.rst
Normal file
5
docs/source/cmd/index_passes_memory.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/memory
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/memory
|
||||
:members:
|
5
docs/source/cmd/index_passes_opt.rst
Normal file
5
docs/source/cmd/index_passes_opt.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/opt
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/opt
|
||||
:members:
|
5
docs/source/cmd/index_passes_pmgen.rst
Normal file
5
docs/source/cmd/index_passes_pmgen.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/pmgen
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/pmgen
|
||||
:members:
|
5
docs/source/cmd/index_passes_proc.rst
Normal file
5
docs/source/cmd/index_passes_proc.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/proc
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/proc
|
||||
:members:
|
5
docs/source/cmd/index_passes_sat.rst
Normal file
5
docs/source/cmd/index_passes_sat.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/sat
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/sat
|
||||
:members:
|
5
docs/source/cmd/index_passes_techmap.rst
Normal file
5
docs/source/cmd/index_passes_techmap.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/techmap
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/techmap
|
||||
:members:
|
5
docs/source/cmd/index_passes_tests.rst
Normal file
5
docs/source/cmd/index_passes_tests.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
passes/tests
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: passes/tests
|
||||
:members:
|
5
docs/source/cmd/index_techlibs.rst
Normal file
5
docs/source/cmd/index_techlibs.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
techlibs
|
||||
------------------
|
||||
|
||||
.. autocmdgroup:: techlibs
|
||||
:members:
|
|
@ -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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue