Skip to content

Commit

Permalink
Use explicit external references
Browse files Browse the repository at this point in the history
  • Loading branch information
Viicos committed Mar 17, 2024
1 parent 49f52a8 commit 52d9f29
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/plugin-development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To get started writing a |Flake8| :term:`plugin` you first need:
Once you've gathered these things, you can get started.

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

- How to register your plugin so |Flake8| can find it
Expand Down
9 changes: 5 additions & 4 deletions docs/source/plugin-development/registering-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ To register any kind of plugin with |Flake8|, you need:
#. A name for your plugin that will (ideally) be unique.

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

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

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

Expand Down Expand Up @@ -151,5 +152,5 @@ point.

.. seealso::

The :external:doc:`setuptools user guide <userguide/entry_point>` about
entry points.
The :external+setuptools:doc:`setuptools user guide <userguide/entry_point>`
about entry points.

0 comments on commit 52d9f29

Please sign in to comment.