Fix various Sphinx build problems

This commit is contained in:
Jakub Warmuz
2015-08-22 14:30:59 +00:00
parent 4b128c69a2
commit e9c79edb19
4 changed files with 24 additions and 17 deletions
@@ -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"))
+15 -10
View File
@@ -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:<port>
1.2.3.4:* -> 1.2.3.4:*
Examples:
- ``1.2.3.4:443`` -> ``1.2.3.4:<port>``
- ``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