diff --git a/docs/api/hash.rst b/docs/api/hash.rst index 4793ce35902524bbaea55f6835f05eeb1277831e..2e1e62e2099872e84ce6b418631c50655fe36675 100644 --- a/docs/api/hash.rst +++ b/docs/api/hash.rst @@ -5,16 +5,16 @@ nacl.hash .. function:: sha256(message, encoder) - Hashes ``message`` with SHA256. + Hashes ``message`` with SHA256. - :param bytes message: The message to hash. - :param encoder: A class that is able to encode the hashed message. - :return bytes: The hashed message. + :param bytes message: The message to hash. + :param encoder: A class that is able to encode the hashed message. + :return bytes: The hashed message. .. function:: sha512(message, encoder) - Hashes ``message`` with SHA512. + Hashes ``message`` with SHA512. - :param bytes message: The message to hash. - :param encoder: A class that is able to encode the hashed message. - :return bytes: The hashed message. + :param bytes message: The message to hash. + :param encoder: A class that is able to encode the hashed message. + :return bytes: The hashed message. diff --git a/docs/signing.rst b/docs/signing.rst index c558b81a6e75cc918ad009dfdc59dc1b053d1a25..274eeb5b1367a544ba46dd372c8e3a99f2ce8565 100644 --- a/docs/signing.rst +++ b/docs/signing.rst @@ -3,11 +3,11 @@ Digital Signatures .. currentmodule:: nacl.signing -You can use a digital signature for many of the same reasons that you might sign -a paper document. A valid digital signature gives a recipient reason to believe -that the message was created by a known sender such that they cannot deny sending -it (authentication and non-repudiation) and that the message was not altered in -transit (integrity). +You can use a digital signature for many of the same reasons that you might +sign a paper document. A valid digital signature gives a recipient reason to +believe that the message was created by a known sender such that they cannot +deny sending it (authentication and non-repudiation) and that the message was +not altered in transit (integrity). Digital signatures allow you to publish a public key, and then you can use your private signing key to sign messages. Others who have your public key can then @@ -204,5 +204,6 @@ Algorithm :k: Ed25519 private key (passed into :class:`~nacl.signing.SigningKey`) :A: Ed25519 public key derived from k :M: message to be signed -:R: a deterministic nonce value calculated from a combination of private key data RH and the message M +:R: a deterministic nonce value calculated from a combination of private key + data RH and the message M :S: Ed25519 signature diff --git a/tox.ini b/tox.ini index d778dfba3fcafb2be9725ab65a9cac6431d47837..37f891f3a9a72fb0dcb49f662ede7e8464058abf 100644 --- a/tox.ini +++ b/tox.ini @@ -12,6 +12,7 @@ commands = [testenv:docs] deps = + doc8 sphinx sphinx_rtd_theme basepython = python2.7 @@ -19,6 +20,7 @@ commands = sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/_build/html sphinx-build -W -b doctest -d {envtmpdir}/doctrees docs docs/_build/html sphinx-build -W -b linkcheck docs docs/_build/html + doc8 README.rst docs/ [testenv:meta] deps =