mirror of
https://github.com/certbot/certbot.git
synced 2026-08-02 00:22:28 +02:00
docs: move plugins.rst to dev guide section
This commit is contained in:
@@ -214,6 +214,26 @@ plugins implement the `~letsencrypt.interfaces.IDisplay`
|
|||||||
interface.
|
interface.
|
||||||
|
|
||||||
|
|
||||||
|
Writing your own plugin
|
||||||
|
=======================
|
||||||
|
|
||||||
|
Let's Encrypt client supports dynamic discovery of plugins through the
|
||||||
|
`setuptools entry points`_. This way you can, for example, create a
|
||||||
|
custom implementation of `~letsencrypt.interfaces.IAuthenticator` or
|
||||||
|
the `~letsencrypt.interfaces.IInstaller` without having to merge it
|
||||||
|
with the core upstream source code. An example is provided in
|
||||||
|
``examples/plugins/`` directory.
|
||||||
|
|
||||||
|
.. warning:: Please be aware though that as this client is still in a
|
||||||
|
developer-preview stage, the API may undergo a few changes. If you
|
||||||
|
believe the plugin will be beneficial to the community, please
|
||||||
|
consider submitting a pull request to the repo and we will update
|
||||||
|
it with any necessary API changes.
|
||||||
|
|
||||||
|
.. _`setuptools entry points`:
|
||||||
|
https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins
|
||||||
|
|
||||||
|
|
||||||
.. _coding-style:
|
.. _coding-style:
|
||||||
|
|
||||||
Coding style
|
Coding style
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ Welcome to the Let's Encrypt client documentation!
|
|||||||
using
|
using
|
||||||
contributing
|
contributing
|
||||||
packaging
|
packaging
|
||||||
plugins
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
=======
|
|
||||||
Plugins
|
|
||||||
=======
|
|
||||||
|
|
||||||
Let's Encrypt client supports dynamic discovery of plugins through the
|
|
||||||
`setuptools entry points`_. This way you can, for example, create a
|
|
||||||
custom implementation of `~letsencrypt.interfaces.IAuthenticator` or
|
|
||||||
the `~letsencrypt.interfaces.IInstaller` without having to merge it
|
|
||||||
with the core upstream source code. An example is provided in
|
|
||||||
``examples/plugins/`` directory.
|
|
||||||
|
|
||||||
.. warning:: Please be aware though that as this client is still in a
|
|
||||||
developer-preview stage, the API may undergo a few changes. If you
|
|
||||||
believe the plugin will be beneficial to the community, please
|
|
||||||
consider submitting a pull request to the repo and we will update
|
|
||||||
it with any necessary API changes.
|
|
||||||
|
|
||||||
.. _`setuptools entry points`:
|
|
||||||
https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins
|
|
||||||
Reference in New Issue
Block a user