Merge pull request #532 from tlsfuzzer/sphinx-fix

use new syntax for intersphinx links
tlsfuzzer · Oct 21, 2024 · 768c262 · 768c262
2 parents 2fc7602 + a209b88
commit 768c262
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -345,5 +345,7 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #
 # texinfo_no_detailmenu = False
-intersphinx_mapping = {'https://docs.python.org/': None,
-                       'https://ecdsa.readthedocs.io/en/latest/': None}
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/', None),
+    'ecdsa': ('https://ecdsa.readthedocs.io/en/latest/', None),
+}
diff --git a/tlslite/handshakesettings.py b/tlslite/handshakesettings.py
@@ -274,7 +274,7 @@ class HandshakeSettings(object):
         The allowed hashes are: "sha1", "sha224", "sha256",
         "sha384" and "sha512".
 
-    "vartype more_sig_schemes: list(str)
+    :vartype more_sig_schemes: list(str)
     :ivar more_sig_schemes: List of additional signatures schemes (ones
         that don't use RSA-PKCS#1 v1.5, RSA-PSS, DSA, or ECDSA) to advertise
         as supported.