3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-07-27 06:27:57 +00:00
yosys/docs/source/index.rst
2025-07-23 14:41:49 +00:00

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:`commandindex`.
.. 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