diff --git a/acme/acme/challenges.py b/acme/acme/challenges.py index cfd6f8533..3f0c203ed 100644 --- a/acme/acme/challenges.py +++ b/acme/acme/challenges.py @@ -149,7 +149,7 @@ class SimpleHTTPResponse(ChallengeResponse): `~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or `~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey` - wrapped in `.ComparableKey + wrapped in `.ComparableKey` :rtype: bool @@ -184,7 +184,7 @@ class SimpleHTTPResponse(ChallengeResponse): `~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or `~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey` - wrapped in `.ComparableKey + wrapped in `.ComparableKey` :param int port: Port used in the validation. :returns: ``True`` iff validation is successful, ``False`` @@ -370,7 +370,7 @@ class DVSNIResponse(ChallengeResponse): `~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or `~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey` - wrapped in `.ComparableKey + wrapped in `.ComparableKey` :param OpenSSL.crypto.X509 cert: Optional certificate. If not provided (``None``) certificate will be retrieved using `probe_cert`. diff --git a/letsencrypt-apache/letsencrypt_apache/configurator.py b/letsencrypt-apache/letsencrypt_apache/configurator.py index 01c9d4f30..8403b974c 100644 --- a/letsencrypt-apache/letsencrypt_apache/configurator.py +++ b/letsencrypt-apache/letsencrypt_apache/configurator.py @@ -953,9 +953,10 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): """Enables an available site, Apache restart required. .. note:: Does not make sure that the site correctly works or that all - modules are enabled appropriately. + modules are enabled appropriately. .. todo:: This function should number subdomains before the domain vhost + .. todo:: Make sure link is not broken... :param vhost: vhost to enable @@ -1034,8 +1035,9 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): .. todo:: This function will be converted to using reload - :raises .errors.MisconfigurationError: If unable to restart due to a - configuration problem, or if the restart subprocess cannot be run. + :raises .errors.MisconfigurationError: If unable to restart due + to a configuration problem, or if the restart subprocess + cannot be run. """ return apache_restart(self.conf("init-script")) diff --git a/letsencrypt-apache/letsencrypt_apache/obj.py b/letsencrypt-apache/letsencrypt_apache/obj.py index c0dcc6c43..8cd2378a4 100644 --- a/letsencrypt-apache/letsencrypt_apache/obj.py +++ b/letsencrypt-apache/letsencrypt_apache/obj.py @@ -41,21 +41,24 @@ class Addr(common.Addr): return 2 def conflicts(self, addr): - """Returns if address could conflict with correct function of self. + r"""Returns if address could conflict with correct function of self. Could addr take away service provided by self within Apache? .. note::IP Address is more important than wildcard. Connection from 127.0.0.1:80 with choices of *:80 and 127.0.0.1:* - chooses 127.0.0.1:* + chooses 127.0.0.1:\* .. todo:: Handle domain name addrs... Examples: - 127.0.0.1:*.conflicts(127.0.0.1:443) - True - 127.0.0.1:443.conflicts(127.0.0.1:*) - False - *:443.conflicts(*:80) - False - _default_:443.conflicts(*:443) - True + + ========================================= ===== + ``127.0.0.1:\*.conflicts(127.0.0.1:443)`` True + ``127.0.0.1:443.conflicts(127.0.0.1:\*)`` False + ``\*:443.conflicts(\*:80)`` False + ``_default_:443.conflicts(\*:443)`` True + ========================================= ===== """ if self._addr_less_specific(addr): @@ -72,9 +75,10 @@ class Addr(common.Addr): def get_sni_addr(self, port): """Returns the least specific address that resolves on the port. - Example: - 1.2.3.4:443 -> 1.2.3.4: - 1.2.3.4:* -> 1.2.3.4:* + Examples: + + - ``1.2.3.4:443`` -> ``1.2.3.4:`` + - ``1.2.3.4:*`` -> ``1.2.3.4:*`` :param str port: Desired port @@ -100,8 +104,9 @@ class VirtualHost(object): # pylint: disable=too-few-public-methods :ivar bool enabled: Virtual host is enabled https://httpd.apache.org/docs/2.4/vhosts/details.html + .. todo:: Any vhost that includes the magic _default_ wildcard is given the - same ServerName as the main server. + same ServerName as the main server. """ # ?: is used for not returning enclosed characters diff --git a/letsencrypt/crypto_util.py b/letsencrypt/crypto_util.py index b7d9987fc..279330f0c 100644 --- a/letsencrypt/crypto_util.py +++ b/letsencrypt/crypto_util.py @@ -267,5 +267,5 @@ def asn1_generalizedtime_to_dt(timestamp): def pyopenssl_x509_name_as_text(x509name): - """Convert `OpenSSL.crypto.X509Name to text.""" + """Convert `OpenSSL.crypto.X509Name` to text.""" return "/".join("{0}={1}" for key, value in x509name.get_components())