Skip to content

Commit c28704f

Browse files
committed
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.
1 parent 726c37e commit c28704f

3 files changed

Lines changed: 14 additions & 0 deletions

File tree

docs/digest.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ interface:
2222

2323
.. autoclass:: _Hash
2424
:members:
25+
:inherited-members:
26+
2527

2628
SHA-1
2729
~~~~~
@@ -32,17 +34,25 @@ SHA-1
3234
are strongly suggested to use SHA-2 over SHA-1.
3335

3436
.. autoclass:: Sha
37+
:members:
38+
:inherited-members:
3539

3640
SHA-2 family
3741
~~~~~~~~~~~~
3842

3943
.. autoclass:: Sha256
44+
:members:
45+
:inherited-members:
4046

4147

4248
.. autoclass:: Sha384
49+
:members:
50+
:inherited-members:
4351

4452

4553
.. autoclass:: Sha512
54+
:members:
55+
:inherited-members:
4656

4757

4858
Example

docs/random.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ vectors can result in major security issues depending on the algorithms in use.
1414

1515
.. autoclass:: Random
1616
:members:
17+
:inherited-members:
1718

1819

1920
Example

docs/symmetric.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ interface:
1818

1919
.. autoclass:: _Cipher
2020
:members:
21+
:inherited-members:
2122

2223
AES
2324
~~~
2425

2526
.. autoclass:: Aes
2627
:members:
28+
:inherited-members:
2729

2830
**Example:**
2931

@@ -43,6 +45,7 @@ Triple DES
4345

4446
.. autoclass:: Des3
4547
:members:
48+
:inherited-members:
4649

4750
**Example:**
4851

0 commit comments

Comments
 (0)