diff --git a/docs/community.rst b/docs/community.rst index 50d3dd3..af77034 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -31,9 +31,9 @@ Communication Souces ====== -* `github.com/chipsalliance `__ +* :gh:`github.com/chipsalliance ` -* `github.com/F4PGA `__ +* :gh:`github.com/F4PGA ` .. _Contributing: diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 38ea1c7..3da5262 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -17,4 +17,4 @@ your FPGA. * `Project Trellis ➚ `__ - * `Project Icestorm ➚ `__ + * :gh:`Project Icestorm ➚ ` diff --git a/docs/how.rst b/docs/how.rst index ab57353..f29abfe 100644 --- a/docs/how.rst +++ b/docs/how.rst @@ -33,14 +33,13 @@ Thus, F4PGA serves as an umbrella project for several activities, the central of so-called FPGA "architecture definitions", i.e. documentation of how specific FPGAs work internally. More information can be found in the :doc:`F4PGA Architecture Definitions ` project. -Those definitions and serve as input to backend tools like -`nextpnr `_ and -`Verilog to Routing `_, and frontend tools -like `Yosys `_. They are created within separate -collaborating projects targeting different FPGAs - :doc:`Project X-Ray -` for Xilinx 7-Series, `Project IceStorm -`_ for Lattice iCE40 and :doc:`Project Trellis -` for Lattice ECP5 FPGAs. +Those definitions and serve as input to backend tools like :gh:`nextpnr ` and `Verilog to Routing `_, +and frontend tools like `Yosys `_. +They are created within separate collaborating projects targeting different FPGAs: + +* :doc:`Project X-Ray ` for Xilinx 7-Series +* `Project IceStorm ` for Lattice iCE40 +* :doc:`Project Trellis ` for Lattice ECP5 FPGAs .. figure:: _static/images/parts.svg @@ -50,7 +49,7 @@ To prepare a working bitstream for a particular FPGA chip, the toolchain goes th * First, a description of the FPGA chip is created with the information from the relevant bitstream documentation project. - This part is done within the `F4PGA Architecture Definitions `__. + This part is done within the :gh:`F4PGA Architecture Definitions `. The project prepares information about the timings and resources available in the chip needed at the implementation stage, as well as techmaps for the synthesis tools. @@ -61,9 +60,8 @@ To prepare a working bitstream for a particular FPGA chip, the toolchain goes th * The next step is implementation. Placement and routing tools put individual blocks from the synthesis description in the specific chip locations and create paths between them. - To do that, F4PGA uses either `nextpnr `__ or `Verilog to Routing `__. + To do that, F4PGA uses either :gh:`nextpnr ` or `Verilog to Routing :gh:`. * Finally, the design properties are translated into a set of features available in the given FPGA chip. - These features are saved in the `fasm format `__, which is developed as part of - F4PGA. + These features are saved in the :gh:`fasm format `, which is developed as part of F4PGA. The fasm file is then translated to bitstream using the information from the bitstream documentation projects. diff --git a/docs/yosys.rst b/docs/yosys.rst index da95de1..3e29ef4 100644 --- a/docs/yosys.rst +++ b/docs/yosys.rst @@ -57,15 +57,13 @@ An example configuration script can be found below: write_blif -attr -cname -param $::env(OUT_EBLIF) write_verilog $::env(OUT_SYNTH_V) -It can be seen that this script performs a platform-specific process of -synthesis, some optimization steps (``opt_`` commands), and writes the final file in -``.eblif`` and Verilog formats. Yosys synthesis configuration scripts are platform-specific -and can by found in ``/yosys/synth.tcl`` -in the `F4PGA Architecture Definitions `_ -repository. +It can be seen that this script performs a platform-specific process of synthesis, some optimization steps (``opt_`` +commands), and writes the final file in ``.eblif`` and Verilog formats. +Yosys synthesis configuration scripts are platform-specific and can by found in ``/yosys/synth.tcl`` in +the :gh:`F4PGA Architecture Definitions ` repository. -To understand performed operations, view the log file. It is usually generated -in the project build directory. It should be named ``top.eblif.log``. +To understand performed operations, view the log file. +It is usually generated in the project build directory. It should be named ``top.eblif.log``. Output analysis ---------------