Skip to content

Commit f66e402

Browse files
committed
Use :rfc: role
1 parent d48a533 commit f66e402

4 files changed

Lines changed: 7 additions & 12 deletions

File tree

source/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ guides:
231231
* `Kivy <https://kivy.org/>`_
232232
* `Beeware <https://pybee.org/>`_
233233
* `Brython <https://brython.info/>`_
234-
* :py:module:`Flexx <flexx:flexx>`
234+
* `Flexx <https://flexx.readthedocs.io/en/latest/>`_
235235

236236
If you are *not* interested in using a framework or platform, or just
237237
wonder about some of the technologies and techniques utilized by the

source/specifications/core-metadata.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,8 +240,7 @@ Historically, PyPI supported descriptions in plain text and `reStructuredText
240240
(reST) <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`_,
241241
and could render reST into HTML. However, it is common for distribution
242242
authors to write the description in `Markdown
243-
<https://daringfireball.net/projects/markdown/>`_ (`RFC 7763
244-
<https://datatracker.ietf.org/doc/html/rfc7763>`_) as many code hosting sites render
243+
<https://daringfireball.net/projects/markdown/>`_ (:rfc:`7763`) as many code hosting sites render
245244
Markdown READMEs, and authors would reuse the file for the description. PyPI
246245
didn't recognize the format and so could not render the description correctly.
247246
This resulted in many packages on PyPI with poorly-rendered descriptions when
@@ -275,10 +274,8 @@ Other parameters might be specific to the chosen subtype. For example, for the
275274
specifying the variant of Markdown in use (defaults to ``GFM`` if not
276275
specified). Currently, two variants are recognized:
277276

278-
- ``GFM`` for `Github-flavored Markdown
279-
<https://datatracker.ietf.org/doc/html/rfc7764#section-3.2>`_
280-
- ``CommonMark`` for `CommonMark
281-
<https://datatracker.ietf.org/doc/html/rfc7764#section-3.5>`_
277+
- ``GFM`` for :rfc:`Github-flavored Markdown <7764#section-3.2>`
278+
- ``CommonMark`` for :rfc:`CommonMark <rfc7764#section-3.5>`
282279

283280
Example::
284281

source/specifications/declaring-project-metadata.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ meaning is open to interpretation.
157157
These fields accept an array of tables with 2 keys: ``name`` and
158158
``email``. Both values must be strings. The ``name`` value MUST be a
159159
valid email name (i.e. whatever can be put as a name, before an email,
160-
in `RFC 822`_) and not contain commas. The ``email`` value MUST be a
160+
in :rfc:`822`) and not contain commas. The ``email`` value MUST be a
161161
valid email address. Both keys are optional.
162162

163163
Using the data to fill in :ref:`core metadata <core-metadata>` is as
@@ -303,5 +303,4 @@ provided via tooling later on.
303303
value, is acceptable).
304304

305305

306-
.. _RFC 822: https://datatracker.ietf.org/doc/html/rfc822
307306
.. _TOML: https://toml.io

source/specifications/direct-url.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ specifying a direct URL reference (including a VCS URL).
2323
This file MUST NOT be created when installing a distribution from an other
2424
type of requirement (i.e. name plus version specifier).
2525

26-
This JSON file MUST be a dictionary, compliant with `RFC 8259
27-
<https://datatracker.ietf.org/doc/html/rfc8259>`_ and UTF-8 encoded.
26+
This JSON file MUST be a dictionary, compliant with :rfc:`8259` and UTF-8 encoded.
2827

2928
If present, it MUST contain at least two fields. The first one is ``url``, with
3029
type ``string``. Depending on what ``url`` refers to, the second field MUST be
@@ -82,7 +81,7 @@ present as a dictionary with the following key:
8281
in editable mode, ``false`` otherwise. If absent, default to ``false``.
8382

8483
When ``url`` refers to a local directory, it MUST have the ``file`` sheme and
85-
be compliant with `RFC 8089 <https://datatracker.ietf.org/doc/html/rfc8089>`_. In
84+
be compliant with :rfc:`8089`. In
8685
particular, the path component must be absolute. Symbolic links SHOULD be
8786
preserved when making relative paths absolute.
8887

0 commit comments

Comments
 (0)