diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 29237ca2382..bd26f43181d 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -109,7 +109,7 @@ Installing all prerequisites for macOS 11 (with Homebrew): Running the build system ^^^^^^^^^^^^^^^^^^^^^^^^ -From the root `yosys` directory, call the following commands: +From the root ``yosys`` directory, call the following commands: .. code:: console @@ -117,7 +117,7 @@ From the root `yosys` directory, call the following commands: sudo make install This will build and then install Yosys, making it available on the command line -as `yosys`. Note that this also downloads, builds, and installs `ABC`_ (using +as ``yosys``. Note that this also downloads, builds, and installs `ABC`_ (using :program:`yosys-abc` as the executable name). .. _ABC: https://github.com/berkeley-abc/abc diff --git a/docs/source/using_yosys/synthesis/techmap_synth.rst b/docs/source/using_yosys/synthesis/techmap_synth.rst index dc9d8b1954b..9e9d42df584 100644 --- a/docs/source/using_yosys/synthesis/techmap_synth.rst +++ b/docs/source/using_yosys/synthesis/techmap_synth.rst @@ -29,8 +29,8 @@ provided implementation. When no map file is provided, techmap uses a built-in map file that maps the Yosys RTL cell types to the internal gate library used by Yosys. The curious -reader may find this map file as `techlibs/common/techmap.v` in the Yosys source -tree. +reader may find this map file as :file:`techlibs/common/techmap.v` in the Yosys +source tree. Additional features have been added to techmap to allow for conditional mapping of cells (see :doc:`/cmd/techmap`). This can for example be useful if the target diff --git a/docs/source/yosys_internals/extending_yosys/extensions.rst b/docs/source/yosys_internals/extending_yosys/extensions.rst index 984613344c6..9e423f9a20d 100644 --- a/docs/source/yosys_internals/extending_yosys/extensions.rst +++ b/docs/source/yosys_internals/extending_yosys/extensions.rst @@ -11,9 +11,9 @@ Writing extensions This chapter contains some bits and pieces of information about programming yosys extensions. Don't be afraid to ask questions on the YosysHQ Slack. -The `guidelines/` directory of the Yosys source code contains notes on various -aspects of Yosys development. In particular, the files GettingStarted and -CodingStyle may be of interest. +The :file:`guidelines/` directory of the Yosys source code contains notes on +various aspects of Yosys development. In particular, the files GettingStarted +and CodingStyle may be of interest. .. todo:: what's in guidelines/GettingStarted that's missing from the manual?