From 66323e32f0c3de16db476f6f15421169948173c2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= <pep@bouah.net>
Date: Mon, 17 Feb 2020 03:03:47 +0100
Subject: plugins: doc for external plugins/entry points
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
---
 doc/source/dev/plugin.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'doc')

diff --git a/doc/source/dev/plugin.rst b/doc/source/dev/plugin.rst
index 7a63ed8f..5ffe7ef5 100644
--- a/doc/source/dev/plugin.rst
+++ b/doc/source/dev/plugin.rst
@@ -1,6 +1,26 @@
 Plugin API documentation
 ========================
 
+External plugins
+----------------
+
+It is possible to create external plugins easily using `setuptools'
+entry_point
+<https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins>`_
+feature. You can register your plugin against the ``poezio_plugins`` entry
+group with the following snippet in your project ``setup.py``:
+
+.. code-block:: python
+
+    setup(
+        ..
+        packages=['yourmodule'],
+        entry_points{'poezio_plugins': 'yourplugin = yourmodule'},
+        ..
+    )
+
+The plugin will then be available as ``yourplugin`` at runtime.
+
 BasePlugin
 ----------
 
-- 
cgit v1.2.3