Skip to content
Snippets Groups Projects
Commit cb255bbc authored by Paul Kehrer's avatar Paul Kehrer
Browse files

Merge pull request #81 from alex/doc8

Use doc8 to style check our docs and fix the voilations
parents 6656b144 92f93977
No related branches found
No related tags found
No related merge requests found
......@@ -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
......@@ -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 =
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment