riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
yosys/docs/source/index.rst

44 lines
1.1 KiB
ReStructuredText
Raw Permalink Normal View History

Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
================================================================================
Reorganising documentation Also changing to furo theme.
2023-08-02 16:20:29 -05:00
Yosys Open SYnthesis Suite
Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
================================================================================
TODOs Blocking tasks are now capital TODO (compared to non-blocking todo). Updated some of the todos. Added note about which intel synth does which families. Rename extended Yosys universe to Yosys family. Added brief text to landing page, and also a note about the restructure and where to find old docs. Moved todolist above ToC in preparation for disabling it in the config (so that it doesn't need it's own header). Fixed pdf build, was previously breaking on trying to include the svg badges.
2023-12-11 17:05:45 -06:00
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`.
Updates to install and tests Includes CAD suite info and details on the OSS CAD suite nightly build targets. Instructions for building from source, largely based on the readme but with some minor modifications. Tests are still WIP, but we replaced the old test suites with a brief comment on the github workflow tests. Still needs more on the tests themselves and how to run them locally. Also an extra todo on the index page.
2023-12-10 17:44:05 -06:00
.. 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
cmdref: Move html only section inside cmd:def Fixes missing links in body and `??` in tag/command index. Update synth.rst to match.
2024-07-18 21:23:31 -05:00
- Also the formatting in pdf uses link formatting instead of code formatting
TODOs Blocking tasks are now capital TODO (compared to non-blocking todo). Updated some of the todos. Added note about which intel synth does which families. Rename extended Yosys universe to Yosys family. Added brief text to landing page, and also a note about the restructure and where to find old docs. Moved todolist above ToC in preparation for disabling it in the config (so that it doesn't need it's own header). Fixed pdf build, was previously breaking on trying to include the svg badges.
2023-12-11 17:05:45 -06:00
.. todolist::
Updates to install and tests Includes CAD suite info and details on the OSS CAD suite nightly build targets. Instructions for building from source, largely based on the readme but with some minor modifications. Tests are still WIP, but we replaced the old test suites with a brief comment on the github workflow tests. Still needs more on the tests themselves and how to run them locally. Also an extra todo on the index page.
2023-12-10 17:44:05 -06:00
New structure headings Also adds a note to readme for installing pdflatex if it's missing.
2023-08-02 16:20:24 -05:00
.. toctree::
Docs: some restructure of advanced section - Filling out index descriptions for `using_yosys` and `using_yosys/synthesis`. - To discourage skipping over these index pages, the toctree in `using_yosys/index` is hidden and instead has inline links to the two subsections. - Tidying todos. - Moves technology mapping to `techmap_synth`, leaving the techmap by example in the internals section. `yosys_flows` gets split up, with the coarse-grain intro replaced by `synthesis/index`, the extract pass moving to `synthesis/extract` and model checking to `more_scripting/model_checking`.
2024-01-25 18:06:02 -06:00
:maxdepth: 3
:includehidden:
Docs: Move appendix toc to main toc Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
2024-05-20 19:17:39 -05:00
Yosys (index) <self>
Docs: some restructure of advanced section - Filling out index descriptions for `using_yosys` and `using_yosys/synthesis`. - To discourage skipping over these index pages, the toctree in `using_yosys/index` is hidden and instead has inline links to the two subsections. - Tidying todos. - Moves technology mapping to `techmap_synth`, leaving the techmap by example in the internals section. `yosys_flows` gets split up, with the coarse-grain intro replaced by `synthesis/index`, the extract pass moving to `synthesis/extract` and model checking to `more_scripting/model_checking`.
2024-01-25 18:06:02 -06:00
introduction
Docs: Move appendix toc to main toc Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
2024-05-20 19:17:39 -05:00
Docs: some restructure of advanced section - Filling out index descriptions for `using_yosys` and `using_yosys/synthesis`. - To discourage skipping over these index pages, the toctree in `using_yosys/index` is hidden and instead has inline links to the two subsections. - Tidying todos. - Moves technology mapping to `techmap_synth`, leaving the techmap by example in the internals section. `yosys_flows` gets split up, with the coarse-grain intro replaced by `synthesis/index`, the extract pass moving to `synthesis/extract` and model checking to `more_scripting/model_checking`.
2024-01-25 18:06:02 -06:00
getting_started/index
using_yosys/index
yosys_internals/index
Docs: Move appendix toc to main toc Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
2024-05-20 19:17:39 -05:00
.. toctree::
:caption: Appendix
:titlesonly:
:includehidden:
appendix/primer
Docs: Move rtlil_text (back) to appendix
2024-05-26 22:47:15 -05:00
appendix/rtlil_text
Docs: Move appendix toc to main toc Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
2024-05-20 19:17:39 -05:00
appendix/auxlibs
appendix/auxprogs
bib
Docs: Update for properties Add properties page, move cell_gate and cell_word under a singular cell_index along with properties. Fix links accordingly. Also drop x-aware and x-output todos since they are resolved.
2024-09-05 22:40:22 -05:00
cell_index
Docs: Move appendix toc to main toc Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
2024-05-20 19:17:39 -05:00
cmd_ref