3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-04-05 17:14:08 +00:00

New structure headings

Also adds a note to readme for installing pdflatex if it's missing.
This commit is contained in:
Krystine Sherwin 2023-08-03 09:20:24 +12:00
parent f37ce5c839
commit 4f1cd66829
No known key found for this signature in database
8 changed files with 92 additions and 2 deletions

View file

@ -602,10 +602,12 @@ Simply visit https://yosys.readthedocs.io/en/latest/ instead.
In addition to those packages listed above for building Yosys from source, the In addition to those packages listed above for building Yosys from source, the
following are used for building the website: following are used for building the website:
$ sudo apt-get install pdf2svg faketime $ sudo apt install pdf2svg faketime
PDFLaTeX, included with most LaTeX distributions, is also needed during the PDFLaTeX, included with most LaTeX distributions, is also needed during the
build process for the website. build process for the website. Or, run the following:
$ sudo apt install texlive-latex-base texlive-latex-extra
The Python package, Sphinx, is needed along with those listed in The Python package, Sphinx, is needed along with those listed in
`docs/source/requirements.txt`: `docs/source/requirements.txt`:

View file

@ -43,6 +43,7 @@ bibtex_bibfiles = ['literature.bib']
exclude_patterns = [ exclude_patterns = [
"CHAPTER_Eval.rst", "CHAPTER_Eval.rst",
"appendix/CHAPTER_StateOfTheArt.rst" "appendix/CHAPTER_StateOfTheArt.rst"
"test_suites.rst"
] ]
latex_elements = { latex_elements = {

View file

@ -0,0 +1,14 @@
Getting started with Yosys
==========================
Installation
------------
Supported platforms
~~~~~~~~~~~~~~~~~~~
Introduction to scripting in Yosys
----------------------------------
Example(s)
----------

View file

@ -27,6 +27,15 @@
Yosys manual Yosys manual
================================================================================ ================================================================================
.. toctree::
:caption: New docs
introduction
getting_started
using_yosys
yosys_internals
.. test_suites
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Manual :caption: Manual

View file

@ -0,0 +1,8 @@
What is Yosys
=============
What you can do with Yosys
--------------------------
The extended Yosys universe
---------------------------

View file

@ -0,0 +1,8 @@
Test suites
===========
Build tests
-----------
Benchmarking
------------

View file

@ -0,0 +1,25 @@
Using Yosys (advanced)
======================
More scripting
--------------
Selections
~~~~~~~~~~
Note on show/viz
Troubleshooting
~~~~~~~~~~~~~~~
Memory map patterns
-------------------
Flows, command types, and order
-------------------------------
Synthesis granularity
~~~~~~~~~~~~~~~~~~~~~
Formal verification
~~~~~~~~~~~~~~~~~~~

View file

@ -0,0 +1,23 @@
Yosys internals
===============
Control and data flow
---------------------
Frontends
~~~~~~~~~
Backends
~~~~~~~~
Passes
~~~~~~
RTLIL
-----
Techmap
-------
Writing extensions
------------------