luke
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
yosys/docs/source/cmd_ref.rst

36 lines
676 B
ReStructuredText
Raw Permalink Normal View History

Rst docs conversion (#3496) Rst docs conversion
2022-11-15 12:55:22 +01:00
================================================================================
Command line reference
================================================================================
Docs: changes from JF `yosys-witness` prereq `click`. Yosys environment vars & `yosys --help` output. Removing Ubuntu/macOS version numbers/names. Hide `troubleshooting` page.
2024-01-23 05:35:06 +01:00
Docs: Rename source/temp to source/generated
2024-04-15 00:13:22 +02:00
.. literalinclude:: /generated/yosys
Docs: changes from JF `yosys-witness` prereq `click`. Yosys environment vars & `yosys --help` output. Removing Ubuntu/macOS version numbers/names. Hide `troubleshooting` page.
2024-01-23 05:35:06 +01:00
:start-at: Usage
Reapply "Add groups to command reference" This reverts commit 81f87ce6ede480de2c976938921eef8b9e79f9db.
2025-08-06 03:52:12 +02:00
.. _cmd_ref:
Command reference
-----------------
.. todo:: Can we warn on command groups that aren't included anywhere?
:ref:`List of all commands<cmd-cmd>`
.. toctree::
:maxdepth: 2
/appendix/env_vars
/cmd/index_frontends
/cmd/index_backends
/cmd/index_kernel
/cmd/index_formal
.. toctree::
:maxdepth: 3
/cmd/index_passes
/cmd/index_techlibs
Docs: Include internal cmds in toctree Also fixing some missing refs (using single backticks instead of double).
2025-07-21 00:36:18 +02:00
.. toctree::
Reapply "Add groups to command reference" This reverts commit 81f87ce6ede480de2c976938921eef8b9e79f9db.
2025-08-06 03:52:12 +02:00
:maxdepth: 2
Docs: Grouping changes Keep techlibs folder hierarchy. techlibs/* and passes/* groups are now nested under index_techlibs and index_passes respectively, with most (all?) of the passes/* pages getting proper headings, as well as backends/frontends/kernel. `index_passes_techmap` also references `index_techlibs`. Split command reference toc in twain, one with maxdepth=2 and one with maxdepth=3, since passes and techlibs now have an extra level of nesting. Move the `cmd_ref` link to the command reference, instead of top of the page. Remove `index_internal` and `index_other` from the toc, and mark the pages as orphan. Internal commands get a note callout after the command reference toc (although this doesn't work for the pdf build), while other commands are linked in the warning for missing `source_location` (since that *should* be the only time when there are any commands in the "unknown" group). Update autodoc extension versions, and mark the directives extension as not `parallel_read_safe` (it might be, but I'm not sure about how the xref lookups work if it is parallel so better to be safe).
2025-07-21 00:35:56 +02:00
Reapply "Add groups to command reference" This reverts commit 81f87ce6ede480de2c976938921eef8b9e79f9db.
2025-08-06 03:52:12 +02:00
/cmd/index_internal