diff --git a/README.md b/README.md index 9f5113931..9192b7b17 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore new file mode 100644 index 000000000..e69de29bb diff --git a/docs/api/client/auth_handler.rst b/docs/api/client/auth_handler.rst index e84745d1e..b52006993 100644 --- a/docs/api/client/auth_handler.rst +++ b/docs/api/client/auth_handler.rst @@ -1,5 +1,5 @@ :mod:`letsencrypt.client.auth_handler` --------------------------------- +-------------------------------------- .. automodule:: letsencrypt.client.auth_handler :members: diff --git a/docs/api/client/client_authenticator.rst b/docs/api/client/client_authenticator.rst index a9050de50..267a0dd50 100644 --- a/docs/api/client/client_authenticator.rst +++ b/docs/api/client/client_authenticator.rst @@ -1,5 +1,5 @@ :mod:`letsencrypt.client.client_authenticator` --------------------------------- +---------------------------------------------- .. automodule:: letsencrypt.client.client_authenticator :members: diff --git a/letsencrypt/client/apache/configurator.py b/letsencrypt/client/apache/configurator.py index edffd7ef4..9f5e6929f 100644 --- a/letsencrypt/client/apache/configurator.py +++ b/letsencrypt/client/apache/configurator.py @@ -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 diff --git a/letsencrypt/client/apache/dvsni.py b/letsencrypt/client/apache/dvsni.py index b513275da..ca8f2d0fb 100644 --- a/letsencrypt/client/apache/dvsni.py +++ b/letsencrypt/client/apache/dvsni.py @@ -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`