Skip to content

Commit

Permalink
Testing latexpdf build
Browse files Browse the repository at this point in the history
Also added `seealso` blocks to example synth.
  • Loading branch information
KrystalDelusion committed Dec 7, 2023
1 parent 25f6a98 commit f949579
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
11 changes: 10 additions & 1 deletion docs/source/getting_started/example_synth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ Our circuit now looks like this:

``counter`` module after :cmd:ref:`hierarchy`

.. seealso:: Advanced usage docs for :doc:`/using_yosys/more_scripting/load_design`

Elaboration
~~~~~~~~~~~

Expand Down Expand Up @@ -158,6 +160,8 @@ Depending on the target architecture, we might also run commands such as
remove tristate and inout constructs respectively, replacing them with logic
suitable for mapping to an FPGA.

.. seealso:: Advanced usage docs for :doc:`/using_yosys/synthesis/proc`

The coarse-grain representation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -184,6 +188,9 @@ Some of the commands we might use here are:
- :doc:`/cmd/alumacc`, and
- :doc:`/cmd/share`.

.. seealso:: Advanced usage docs for :doc:`/using_yosys/synthesis/fsm`, and
:doc:`/using_yosys/synthesis/memory`

Logic gate mapping
~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -239,6 +246,8 @@ Mapping to hardware
:cmd:ref:`dfflegalize`
Specify a set of supported FF cells/cell groups and convert all FFs to them.

.. seealso:: Advanced usage docs for :doc:`/yosys_internals/techmap`

.. _cmos_lib:

The CMOS cell library
Expand All @@ -261,4 +270,4 @@ The script file
:language: yoscrypt
:caption: ``docs/source/code_examples/intro/counter.ys``

See also :doc:`/using_yosys/synthesis/synth`.
.. seealso:: Advanced usage docs for :doc:`/using_yosys/synthesis/synth`
20 changes: 16 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
Yosys Open SYnthesis Suite
================================================================================

.. todo:: better landing page

Consider adding something here that isn't just table of contents since this
*is* the root page and is where the logo links to.

.. only:: html

Table of contents
-----------------

.. toctree::
:maxdepth: 3

Expand All @@ -13,11 +23,13 @@ Yosys Open SYnthesis Suite

appendix

Indices
-------
.. only:: html

Indices
-------

- :ref:`commandindex`
- :ref:`tagindex`
- :ref:`commandindex`
- :ref:`tagindex`

TODOs
-----
Expand Down

0 comments on commit f949579

Please sign in to comment.