From c28704f22c12b5c32882314e9abb5817c4dc8295 Mon Sep 17 00:00:00 2001 From: Andrew Hutchings Date: Tue, 8 Feb 2022 16:26:30 +0000 Subject: [PATCH] Fix missing class members from docs Inherited class members were missing from class documentation. Most classes rely on these so this makes them visible in the docs. --- docs/digest.rst | 10 ++++++++++ docs/random.rst | 1 + docs/symmetric.rst | 3 +++ 3 files changed, 14 insertions(+) diff --git a/docs/digest.rst b/docs/digest.rst index 0d79f8e..765bf12 100644 --- a/docs/digest.rst +++ b/docs/digest.rst @@ -22,6 +22,8 @@ interface: .. autoclass:: _Hash :members: + :inherited-members: + SHA-1 ~~~~~ @@ -32,17 +34,25 @@ SHA-1 are strongly suggested to use SHA-2 over SHA-1. .. autoclass:: Sha + :members: + :inherited-members: SHA-2 family ~~~~~~~~~~~~ .. autoclass:: Sha256 + :members: + :inherited-members: .. autoclass:: Sha384 + :members: + :inherited-members: .. autoclass:: Sha512 + :members: + :inherited-members: Example diff --git a/docs/random.rst b/docs/random.rst index ba8e33b..803abc0 100644 --- a/docs/random.rst +++ b/docs/random.rst @@ -14,6 +14,7 @@ vectors can result in major security issues depending on the algorithms in use. .. autoclass:: Random :members: + :inherited-members: Example diff --git a/docs/symmetric.rst b/docs/symmetric.rst index e4a9fc1..fc503c3 100644 --- a/docs/symmetric.rst +++ b/docs/symmetric.rst @@ -18,12 +18,14 @@ interface: .. autoclass:: _Cipher :members: + :inherited-members: AES ~~~ .. autoclass:: Aes :members: + :inherited-members: **Example:** @@ -43,6 +45,7 @@ Triple DES .. autoclass:: Des3 :members: + :inherited-members: **Example:**