From 74c1fc1cdd2ee83b48aea0ff19b943305f4a1f9d Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Mon, 30 Oct 2023 22:38:47 +1300 Subject: [PATCH] docs: Reference chapters with doc tag Fix some formatting. --- docs/source/appendix/auxprogs.rst | 2 +- docs/source/introduction.rst | 3 ++- docs/source/using_yosys/more_scripting/opt_passes.rst | 6 +++--- docs/source/yosys_internals/extensions.rst | 2 -- docs/source/yosys_internals/formats/rtlil_text.rst | 4 ++-- 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/source/appendix/auxprogs.rst b/docs/source/appendix/auxprogs.rst index a80e8f535..41570b086 100644 --- a/docs/source/appendix/auxprogs.rst +++ b/docs/source/appendix/auxprogs.rst @@ -11,7 +11,7 @@ yosys-config The yosys-config tool (an auto-generated shell-script) can be used to query compiler options and other information needed for building loadable modules for -Yosys. See :ref:`chapter:prog` for details. +Yosys. See :doc:`/yosys_internals/extensions` for details. .. _sec:filterlib: diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 6a3f8802e..62c76584d 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -67,7 +67,8 @@ Things you can't do - Process high-level languages such as C/C++/SystemC - Create physical layouts (place&route) - + Check out `nextpnr`_ for that + + - Check out `nextpnr`_ for that .. _nextpnr: https://github.com/YosysHQ/nextpnr diff --git a/docs/source/using_yosys/more_scripting/opt_passes.rst b/docs/source/using_yosys/more_scripting/opt_passes.rst index 4437a4796..f3c9c92f9 100644 --- a/docs/source/using_yosys/more_scripting/opt_passes.rst +++ b/docs/source/using_yosys/more_scripting/opt_passes.rst @@ -37,9 +37,9 @@ The :cmd:ref:`opt_expr` pass ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This pass performs const folding on the internal combinational cell types -described in :ref:`chapter:celllib`. This means a cell with all constant inputs -is replaced with the constant value this cell drives. In some cases this pass -can also optimize cells with some constant inputs. +described in :doc:`/yosys_internals/formats/cell_library`. This means a cell +with all constant inputs is replaced with the constant value this cell drives. +In some cases this pass can also optimize cells with some constant inputs. .. table:: Const folding rules for ``$_AND_`` cells as used in :cmd:ref:`opt_expr`. :name: tab:opt_expr_and diff --git a/docs/source/yosys_internals/extensions.rst b/docs/source/yosys_internals/extensions.rst index 68d023d64..ec9f2b8d0 100644 --- a/docs/source/yosys_internals/extensions.rst +++ b/docs/source/yosys_internals/extensions.rst @@ -1,5 +1,3 @@ -.. _chapter:prog: - Writing extensions ================== diff --git a/docs/source/yosys_internals/formats/rtlil_text.rst b/docs/source/yosys_internals/formats/rtlil_text.rst index a7f1d843b..8b5c10681 100644 --- a/docs/source/yosys_internals/formats/rtlil_text.rst +++ b/docs/source/yosys_internals/formats/rtlil_text.rst @@ -223,8 +223,8 @@ Cells Declares a cell, with zero or more attributes, with the given identifier and type in the enclosing module. -Cells perform functions on input signals. See :ref:`chapter:celllib` for a -detailed list of cell types. +Cells perform functions on input signals. See +:doc:`/yosys_internals/formats/cell_library` for a detailed list of cell types. .. code:: BNF