Skip to content

Commit 350f254

Browse files
committed
Use explicit external references
1 parent 49f52a8 commit 350f254

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/source/plugin-development/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To get started writing a |Flake8| :term:`plugin` you first need:
3131
Once you've gathered these things, you can get started.
3232

3333
All plugins for |Flake8| must be registered via
34-
:external:doc:`entry points<specifications/entry-points>`. In this
34+
:external+packaging:doc:`entry points<specifications/entry-points>`. In this
3535
section we cover:
3636

3737
- How to register your plugin so |Flake8| can find it

docs/source/plugin-development/registering-plugins.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ To register any kind of plugin with |Flake8|, you need:
1313
#. A name for your plugin that will (ideally) be unique.
1414

1515
|Flake8| relies on functionality provided by build tools called
16-
:external:doc:`entry points<specifications/entry-points>`. These allow
17-
any package to register a plugin with |Flake8| via that package's metadata.
16+
:external+packaging:doc:`entry points<specifications/entry-points>`. These
17+
allow any package to register a plugin with |Flake8| via that package's
18+
metadata.
1819

1920
Let's presume that we already have our plugin written and it's in a module
21+
:external+packaging:term:`Build Backend`, but be aware that most backends
2022
called ``flake8_example``. We will also assume ``setuptools`` is used as a
21-
:term:`Build Backend`, but be aware that most backends support entry points.
23+
support entry points.
2224

2325
We might have a ``setup.py`` that looks something like:
2426

@@ -151,5 +153,5 @@ point.
151153

152154
.. seealso::
153155

154-
The :external:doc:`setuptools user guide <userguide/entry_point>` about
155-
entry points.
156+
The :external+setuptools:doc:`setuptools user guide <userguide/entry_point>`
157+
about entry points.

0 commit comments

Comments
 (0)