Skip to content

Commit

Permalink
docs(plugin): explain plugin registration (#3116)
Browse files Browse the repository at this point in the history
  • Loading branch information
hashar authored Sep 8, 2023
1 parent 1371e98 commit 381e37a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/changelog/3116.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Explain how plugins are registered and discovered - by :user:`hashar`.
17 changes: 15 additions & 2 deletions src/tox/plugin/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
"""
tox uses `pluggy <https://pluggy.readthedocs.io/en/stable/>`_ to customize the default behaviour. For example the
following code snippet would define a new ``--magic`` command line interface flag the user can specify:
tox uses `pluggy <https://pluggy.readthedocs.io/en/stable/>`_ to customize the default behaviour. It provides an
extension mechanism for plugin management an calling hooks.
Pluggy discovers a plugin by looking up for entry-points named ``tox``, for example in a pyproject.toml:
.. code-block:: toml
[project.entry-points.tox]
your_plugin = "your_plugin.hooks"
Therefore, to start using a plugin, you solely need to install it in the same environment tox is running in and it will
be discovered via the defined entry-point (in the example above, tox will load ``your_plugin.hooks``).
A plugin is created by implementing extension points in the form of hooks. For example the following code snippet would
define a new ``--magic`` command line interface flag the user can specify:
.. code-block:: python
Expand Down

0 comments on commit 381e37a

Please sign in to comment.