Various docstring fixes.

- Use r""" \* """
- transform plugins note to ..warning
- ' -> ` for cross-reference
- fix some "more than one target found for cross-reference" warnings
This commit is contained in:
Jakub Warmuz
2015-05-28 15:17:55 +00:00
parent 9bc9abecbe
commit 2178315f8a
4 changed files with 27 additions and 24 deletions
+8 -8
View File
@@ -4,16 +4,16 @@ 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
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.
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.
.. 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