diff options
| author | Hubert Kario <hubert@kario.pl> | 2022-04-03 18:26:13 +0200 |
|---|---|---|
| committer | Hubert Kario <hkario@redhat.com> | 2022-07-08 14:26:26 +0200 |
| commit | 6e8e6adc8a99aead59706e0ec22a254dca763cf5 (patch) | |
| tree | 2035199666d41f547f85c82283524866a844f0f1 | |
| parent | 00790925fe7899e14a0c39ba39e56af5da75652c (diff) | |
| download | ecdsa-6e8e6adc8a99aead59706e0ec22a254dca763cf5.tar.gz | |
add glossary module
| -rw-r--r-- | docs/source/glossary.rst | 23 | ||||
| -rw-r--r-- | docs/source/index.rst | 5 | ||||
| -rw-r--r-- | docs/source/modules.rst | 4 |
3 files changed, 30 insertions, 2 deletions
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst new file mode 100644 index 0000000..78332b7 --- /dev/null +++ b/docs/source/glossary.rst @@ -0,0 +1,23 @@ +.. _glossary: + +Glossary +======== + +.. glossary:: + :sorted: + + ECC + Elliptic Curve Cryptography, a term for all the different ways of using + elliptic curves in cryptography. Also combined term for :term:`ECDSA`, + :term:`EdDSA`, :term:`ECDH`. + + ECDSA + Elliptic Curve Digital Signature Algorithm + + EdDSA + Edwards curve based Digital Signature Algorithm, the alternative + digital signature algorithm that's used for Curve25519 or Curve448 + + ECDH + Elliptic Curve Diffie-Hellman + diff --git a/docs/source/index.rst b/docs/source/index.rst index 1fb7c17..8b1d2a1 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,6 +23,10 @@ or .. toctree:: :maxdepth: 2 :caption: Contents: + :hidden: + + glossary + modules @@ -31,4 +35,5 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` +* :ref:`glossary` * :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst index d74a83e..f5c495b 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,5 +1,5 @@ -src -=== +python-ecdsa API +================ .. toctree:: :maxdepth: 4 |