mirror of
https://github.com/YosysHQ/yosys
synced 2025-04-23 17:15:33 +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).
43 lines
1.1 KiB
ReStructuredText
43 lines
1.1 KiB
ReStructuredText
================================================================================
|
|
Yosys Open SYnthesis Suite
|
|
================================================================================
|
|
|
|
Yosys is an open source framework for RTL synthesis. To learn more about Yosys,
|
|
see :doc:`/introduction`. For a quick guide on how to get started using Yosys,
|
|
check out :doc:`/getting_started/index`. For the complete list of commands
|
|
available, go to :ref:`cmd_ref`.
|
|
|
|
.. todo:: look into command ref improvements
|
|
|
|
- Search bar with live drop down suggestions for matching on title /
|
|
autocompleting commands
|
|
- Scroll the left sidebar to the current location on page load
|
|
- Also the formatting in pdf uses link formatting instead of code formatting
|
|
|
|
.. todolist::
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
Yosys (index) <self>
|
|
introduction
|
|
|
|
getting_started/index
|
|
using_yosys/index
|
|
yosys_internals/index
|
|
|
|
.. toctree::
|
|
:caption: Appendix
|
|
:titlesonly:
|
|
:includehidden:
|
|
|
|
appendix/primer
|
|
appendix/rtlil_text
|
|
appendix/auxlibs
|
|
appendix/auxprogs
|
|
|
|
bib
|
|
|
|
cell_index
|
|
cmd_ref
|