yosys/docs/source/index.rst

55 lines
1.6 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`.
.. note::
This documentation recently went through a major restructure. If you're
looking for something from the previous version and can't find it here,
please `let us know`_. Documentation from before the restructure can still
be found by switching to `version 0.36`_ or earlier. Note that the previous
theme does not include a version switcher.
.. _let us know: https://github.com/YosysHQ/yosys/issues/new/choose
.. _version 0.36: https://yosyshq.readthedocs.io/projects/yosys/en/0.36/
.. 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