From f949579cf3aac26b35ad16138717dae90104c50c Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Fri, 8 Dec 2023 11:19:12 +1300 Subject: [PATCH] Testing latexpdf build Also added `seealso` blocks to example synth. --- docs/source/getting_started/example_synth.rst | 11 +++++++++- docs/source/index.rst | 20 +++++++++++++++---- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/docs/source/getting_started/example_synth.rst b/docs/source/getting_started/example_synth.rst index b3d4aa679..c4da2dd8c 100644 --- a/docs/source/getting_started/example_synth.rst +++ b/docs/source/getting_started/example_synth.rst @@ -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 ~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~~~~ @@ -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 @@ -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` diff --git a/docs/source/index.rst b/docs/source/index.rst index 0a776393a..c19036f81 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 @@ -13,11 +23,13 @@ Yosys Open SYnthesis Suite appendix -Indices -------- +.. only:: html -- :ref:`commandindex` -- :ref:`tagindex` + Indices + ------- + + - :ref:`commandindex` + - :ref:`tagindex` TODOs -----