mirror of
https://github.com/YosysHQ/yosys
synced 2025-08-24 03:57:54 +00:00
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).
This commit is contained in:
parent
0ec336ba23
commit
37782cb92b
41 changed files with 183 additions and 41 deletions
|
@ -1,9 +1,11 @@
|
|||
techlibs
|
||||
------------------
|
||||
Technology libraries
|
||||
====================
|
||||
|
||||
.. TODO:: disambiguate `synth_intel` and `synth_intel_alm`
|
||||
Listed in alphabetical order.
|
||||
|
||||
(MAX10, Cyclone IV) and (Cyclone V, Arria V, Cyclone 10 GX) respectively
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:glob:
|
||||
|
||||
.. autocmdgroup:: techlibs
|
||||
:members:
|
||||
/cmd/index_techlibs_common
|
||||
/cmd/index_techlibs_*
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue