From ce5a32f3fdbcb5128800719e2c3d68e6248d3e47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Wed, 20 Jul 2022 11:00:13 +0200 Subject: Fix #199: Sphinx warnings reference target not found Fix the documentation by adding referenced-but-not-included functions and some other small fixes. The only warnings left are: ``` python-rsa/rsa/key.py:docstring of rsa.key.AbstractKey.load_pkcs1:: WARNING: py:class reference target not found: rsa.key.T python-rsa/rsa/key.py:docstring of rsa.key.AbstractKey.load_pkcs1:: WARNING: py:class reference target not found: rsa.key.T ``` These are due to Sphynx not really understanding `typing` type references. Not sure how to fix those. --- doc/reference.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'doc/reference.rst') diff --git a/doc/reference.rst b/doc/reference.rst index 9da7c6b..a0d9b6b 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -17,7 +17,13 @@ Functions .. autofunction:: rsa.find_signature_hash -.. autofunction:: rsa.newkeys(keysize) +.. autofunction:: rsa.newkeys + +.. autofunction:: rsa.sign_hash + +.. autofunction:: rsa.compute_hash + +.. autodata:: rsa.pkcs1.HASH_METHODS Classes @@ -31,6 +37,8 @@ Classes constructed data. Never unpickle data received from an untrusted or unauthenticated source. +.. autoclass:: rsa.key.AbstractKey + .. autoclass:: rsa.PublicKey :members: :inherited-members: -- cgit v1.2.1