Merge branch 'plugins-entrygroup' into 'master'

plugins: Allow entry_points to be registered

See merge request poezio/poezio!67

1 files changed, 20 insertions, 0 deletions

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
 ----------