Skip to content

Commit f8e7f03

Browse files
committed
use sphinx roles where possible in index.rst
Signed-off-by: Oleg Höfling <[email protected]>
1 parent 58b0fa0 commit f8e7f03

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

importlib_metadata/docs/index.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
===============================
44

55
``importlib_metadata`` is a library which provides an API for accessing an
6-
installed package's `metadata`_, such as its entry points or its top-level
6+
installed package's :pep:`metadata <566>`, such as its entry points or its top-level
77
name. This functionality intends to replace most uses of ``pkg_resources``
8-
`entry point API`_ and `metadata API`_. Along with ``importlib.resources`` in
9-
`Python 3.7 and newer`_ (backported as `importlib_resources`_ for older
8+
`entry point API`_ and `metadata API`_. Along with :mod:`importlib.resources` in
9+
Python 3.7 and newer (backported as :doc:`importlib_resources <importlib_resources:index>` for older
1010
versions of Python), this can eliminate the need to use the older and less
1111
efficient ``pkg_resources`` package.
1212

1313
``importlib_metadata`` is a backport of Python 3.8's standard library
14-
`importlib.metadata`_ module for Python 2.7, and 3.4 through 3.7. Users of
14+
:doc:`importlib.metadata <library/importlib.metadata>` module for Python 2.7, and 3.4 through 3.7. Users of
1515
Python 3.8 and beyond are encouraged to use the standard library module.
1616
When imported on Python 3.8 and later, ``importlib_metadata`` replaces the
1717
DistributionFinder behavior from the stdlib, but leaves the API in tact.
@@ -46,9 +46,5 @@ Indices and tables
4646
* :ref:`search`
4747

4848

49-
.. _`metadata`: https://www.python.org/dev/peps/pep-0566/
5049
.. _`entry point API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points
5150
.. _`metadata API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api
52-
.. _`Python 3.7 and newer`: https://docs.python.org/3/library/importlib.html#module-importlib.resources
53-
.. _`importlib_resources`: https://importlib-resources.readthedocs.io/en/latest/index.html
54-
.. _`importlib.metadata`: https://docs.python.org/3/library/importlib.metadata.html

0 commit comments

Comments
 (0)