diff --git a/docs/plugins.rst b/docs/plugins.rst index c4df1180a..33d63e84f 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -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 diff --git a/letsencrypt/auth_handler.py b/letsencrypt/auth_handler.py index e83cdd717..37d818dbe 100644 --- a/letsencrypt/auth_handler.py +++ b/letsencrypt/auth_handler.py @@ -53,12 +53,12 @@ class AuthHandler(object): """Retrieve all authorizations for challenges. :param set domains: Domains for authorization - :param bool best_effort: Whether or not all authorizations are required - (this is useful in renewal) + :param bool best_effort: Whether or not all authorizations are + required (this is useful in renewal) - :returns: tuple of lists of authorization resources. Takes the form of - (`completed`, `failed`) - rtype: tuple + :returns: tuple of lists of authorization resources. Takes the + form of (`completed`, `failed`) + :rtype: tuple :raises AuthorizationError: If unable to retrieve all authorizations diff --git a/letsencrypt/interfaces.py b/letsencrypt/interfaces.py index e154bd5d3..7c61dc554 100644 --- a/letsencrypt/interfaces.py +++ b/letsencrypt/interfaces.py @@ -49,7 +49,7 @@ class IPluginFactory(zope.interface.Interface): """Inject argument parser options (flags). 1. Be nice and prepend all options and destinations with - `~.option_namespace` and `~.dest_namespace`. + `~.common.option_namespace` and `~common.dest_namespace`. 2. Inject options (flags) only. Positional arguments are not allowed, as this would break the CLI. diff --git a/letsencrypt_nginx/obj.py b/letsencrypt_nginx/obj.py index 9b3fa2e42..9e1f78e48 100644 --- a/letsencrypt_nginx/obj.py +++ b/letsencrypt_nginx/obj.py @@ -5,22 +5,25 @@ from letsencrypt_apache.obj import Addr as ApacheAddr class Addr(ApacheAddr): - """Represents an Nginx address, i.e. what comes after the 'listen' + r"""Represents an Nginx address, i.e. what comes after the 'listen' directive. - According to http://nginx.org/en/docs/http/ngx_http_core_module.html#listen, - this may be address[:port], port, or unix:path. The latter is ignored here. + According to the `documentation`_, this may be address[:port], port, + or unix:path. The latter is ignored here. - The default value if no directive is specified is *:80 (superuser) or - *:8000 (otherwise). If no port is specified, the default is 80. If no - address is specified, listen on all addresses. + The default value if no directive is specified is \*:80 (superuser) + or \*:8000 (otherwise). If no port is specified, the default is + 80. If no address is specified, listen on all addresses. - .. todo:: Old-style nginx configs define SSL vhosts in a separate block - instead of using 'ssl' in the listen directive + .. _documentation: + http://nginx.org/en/docs/http/ngx_http_core_module.html#listen + + .. todo:: Old-style nginx configs define SSL vhosts in a separate + block instead of using 'ssl' in the listen directive. :param str addr: addr part of vhost address, may be hostname, IPv4, IPv6, - "", or "*" - :param str port: port number or "*" or "" + "", or "\*" + :param str port: port number or "\*" or "" :param bool ssl: Whether the directive includes 'ssl' :param bool default: Whether the directive includes 'default_server'