diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/dev/plugin.rst | 20 | ||||
| -rw-r--r-- | doc/source/plugins/index.rst | 8 |
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/source/dev/plugin.rst b/doc/source/dev/plugin.rst index 7a63ed8f..6a7605b2 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 ---------- diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst index c1d8ded1..59801784 100644 --- a/doc/source/plugins/index.rst +++ b/doc/source/plugins/index.rst @@ -145,6 +145,14 @@ Plugin index Sends the current song (and optionally the progress inside the song) to the current (chat) tab. + OMEMO + *Not distributed with Poezio.* See https://lab.louiz.org/poezio/poezio-omemo. + + `Documentation <https://lab.louiz.org/poezio/poezio-omemo>`_ + + Allows for end-to-end encrypted exchanges using the OMEMO + mechanism. + OTR :ref:`Documentation <otr-plugin>` |