Fix docs warnings

This commit is contained in:
Jakub Warmuz
2015-01-24 13:13:13 +00:00
parent 23cab4e694
commit 48f1497af6
6 changed files with 6 additions and 6 deletions
+1 -1
View File
@@ -77,7 +77,7 @@ In order to generate the sphinx documentation, run the following commands.
```
./venv/bin/python setup.py docs
cd docs
make html SPHINXBUILD='../venv/bin/python ../venv/bin/sphinx-build'
make clean html SPHINXBUILD=../venv/bin/sphinx-build
```
This should generate documentation in the /lets-encrypt-preview/docs/_build/html
View File
+1 -1
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.client.auth_handler`
--------------------------------
--------------------------------------
.. automodule:: letsencrypt.client.auth_handler
:members:
+1 -1
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.client.client_authenticator`
--------------------------------
----------------------------------------------
.. automodule:: letsencrypt.client.client_authenticator
:members:
+2 -2
View File
@@ -532,7 +532,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
:param str domain: domain to enhance
:param str enhancement: enhancement type defined in
:class:`letsencrypt.client.CONFIG.ENHANCEMENTS
:class:`letsencrypt.client.CONFIG.ENHANCEMENTS`
:param options: options for the enhancement
:type options: See :class:`letsencrypt.client.CONFIG.ENHANCEMENTS`
documentation for appropriate parameter.
@@ -979,7 +979,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
fulfilled by configurator.
:returns: list of responses. All responses are returned in the same
order as received by the perform function. A None response
order as received by the perform function. A None response
indicates the challenge was not perfromed.
:rtype: list
+1 -1
View File
@@ -17,7 +17,7 @@ class ApacheDvsni(object):
:ivar dvsni_chall: Data required for challenges.
where DvsniChall tuples have the following fields
`domain` (`str`), `r_b64` (base64 `str`), `nonce` (hex `str`)
`key` (:class:`letsencrypt.client.client.Client.Key`)
`key` (:class:`letsencrypt.client.client.Client.Key`)
:type dvsni_chall: `list` of
:class:`letsencrypt.client.challenge_util.DvsniChall`