Skip to content

Commit eb2b086

Browse files
committed
docs: fix link rot.
1 parent e3324e1 commit eb2b086

File tree

5 files changed

+11
-10
lines changed

5 files changed

+11
-10
lines changed

amaranth/lib/crc/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class Algorithm:
5454
form of polynomial but remove the leading '1'.
5555
5656
.. _reveng: https://reveng.sourceforge.io/crc-catalogue/all.htm
57-
.. _crcmod: http://crcmod.sourceforge.net/crcmod.predefined.html
57+
.. _crcmod: https://crcmod.sourceforge.net/crcmod.predefined.html
5858
.. _CRC Zoo: https://users.ece.cmu.edu/~koopman/crc/
5959
6060
Many commonly used CRC algorithms are available in the

docs/contrib.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Filing problem reports
99

1010
We would like Amaranth to be a best-in-class design tool, and hearing about issues people encounter while using it is crucial for improving it. While we do care a lot about correctness of the results, we care about the experience of using the tool just as much. Amaranth is meant to be a tool that is comfortable to use: with fewer sharp edges (no matter how much technological appeal they might have) and more signs and guardrails.
1111

12-
Please `report <issues>`_ any problems you encounter using Amaranth. To go beyond that: **If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.**
12+
Please `report <issues_>`_ any problems you encounter using Amaranth. To go beyond that: **If, while you are using Amaranth, you see an error message that is hard to understand or is misleading, please report it as a bug. Even (especially!) if you think you did something wrong.**
1313

14-
.. _issues: https://github.com/amaranth-lang/amaranth
14+
.. _issues: https://github.com/amaranth-lang/amaranth/issues
1515

1616
When filing problem reports, please include the following information:
1717

@@ -34,7 +34,7 @@ Proposing new features
3434

3535
Amaranth is a programming language and a toolchain, which is different from many other kinds of open source projects in that just about every part of it is, unavoidably, tightly coupled to every other one, the result being that seemingly obvious and apparently minor decisions can have dramatic consequences years later.
3636

37-
To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, **all substantial changes, including feature proposals, must go through a formal Request for Comments process**. The process, as well as the accepted proposals, are described `here <rfcs>`_. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.
37+
To make sure that new features undergo the scrutiny necessary for commitment to many years of support, and to make sure that everyone in the community who will be impacted by the changes has a chance to make their voice heard, **all substantial changes, including feature proposals, must go through a formal Request for Comments process**. The process, as well as the accepted proposals, are described `here <rfcs_>`_. Typically, substantial changes are accepted after one to several rounds of community review achieve near-unanimous consensus.
3838

3939
.. _rfcs: https://amaranth-lang.org/rfcs/
4040

@@ -48,8 +48,8 @@ Preparing the environment
4848

4949
The Amaranth codebase uses the PDM_ package and dependency manager to structure the development workflow. Please `install PDM`_ first and make sure you have downloaded the latest changes to the source files. Once you have done so, run:
5050

51-
.. _PDM: https://pdm.fming.dev/
52-
.. _install PDM: https://pdm.fming.dev/latest/#recommended-installation-method
51+
.. _PDM: https://pdm-project.org/
52+
.. _install PDM: https://pdm-project.org/latest/#recommended-installation-method
5353

5454
.. code-block:: console
5555

docs/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Synthesizing, placing and routing an Amaranth design for an FPGA requires the FP
2121
.. _pip: https://pip.pypa.io/
2222
.. _Yosys: https://yosyshq.net/yosys/
2323
.. _PyPI: https://pypi.org/
24-
.. _GTKWave: http://gtkwave.sourceforge.net/
24+
.. _GTKWave: https://gtkwave.sourceforge.net/
2525

2626

2727
.. _install-deps:
@@ -109,7 +109,7 @@ Installing prerequisites
109109

110110
If Yosys |yosys-version| is not available, `build Yosys from source`_.
111111

112-
.. _build Yosys from source: https://github.com/YosysHQ/yosys/#setup
112+
.. _build Yosys from source: https://github.com/YosysHQ/yosys/#building-from-source
113113

114114
|upgrade-pip|
115115

docs/intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ The Amaranth simulator is event-driven and can simulate designs with multiple cl
5757

5858
Although Amaranth does not support native code simulation or co-simulation at the moment, such support will be added in near future.
5959

60-
.. _Icarus Verilog: http://iverilog.icarus.com/
61-
.. _Verilator: https://www.veripool.org/wiki/verilator
60+
.. _Icarus Verilog: https://steveicarus.github.io/iverilog/
61+
.. _Verilator: https://www.veripool.org/verilator/
6262
.. _GTKWave: http://gtkwave.sourceforge.net/
6363
.. _PyPy: https://www.pypy.org/
6464

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ test-docs.cmd = "sphinx-build -b doctest docs/ docs/_build"
8080

8181
document.cmd = "sphinx-build docs/ docs/_build/"
8282
document-live.cmd = "sphinx-autobuild docs/ docs/_build/ --watch amaranth"
83+
document-linkcheck.cmd = "sphinx-build docs/ docs/_build/ -b linkcheck"
8384

8485
coverage-text.cmd = "python -m coverage report"
8586
coverage-html.cmd = "python -m coverage html"

0 commit comments

Comments
 (0)