mirror of
https://github.com/YosysHQ/yosys
synced 2025-04-25 18:15:34 +00:00
a74aeb1301
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).
35 lines
754 B
ReStructuredText
35 lines
754 B
ReStructuredText
================================================================================
|
|
Command line reference
|
|
================================================================================
|
|
|
|
.. literalinclude:: /generated/yosys
|
|
:start-at: Usage
|
|
|
|
.. _cmd_ref:
|
|
|
|
Command reference
|
|
-----------------
|
|
|
|
.. todo:: Can we warn on command groups that aren't included anywhere?
|
|
|
|
.. 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
|
|
|
|
.. TODO:: Fix index_internal not being included in pdf
|
|
|
|
.. note::
|
|
|
|
Commands intended for internal developer use can also be found under
|
|
:doc:`/cmd/index_internal`
|