Skip to content

Commit

Permalink
Docs: Fix invalid autorefs
Browse files Browse the repository at this point in the history
  • Loading branch information
KrystalDelusion committed May 27, 2024
1 parent f0cc487 commit 5f81b8d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ 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
make
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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/using_yosys/synthesis/techmap_synth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/source/yosys_internals/extending_yosys/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down

0 comments on commit 5f81b8d

Please sign in to comment.