upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-04-29 02:02:00 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: move plugins.rst to dev guide section

Browse source
This commit is contained in:
Jakub Warmuz 2015-10-24 19:31:41 +00:00
parent c84e9b2950
commit d079df9cd5
No known key found for this signature in database
GPG key ID: 2A7BAD3A489B52EA
3 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/contributing.rst
View file

@ -214,6 +214,26 @@ plugins implement the `~letsencrypt.interfaces.IDisplay`
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

1
docs/index.rst
View file

@ -8,7 +8,6 @@ Welcome to the Let's Encrypt client documentation!
using
contributing
packaging
plugins
.. toctree::
:maxdepth: 1

19
docs/plugins.rst
View file

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