add BytesIO alias to fix missing references in docs

nulano · Jan 20, 2024 · 23b3e92 · 23b3e92
1 parent 4aa3341
commit 23b3e92
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,6 +40,11 @@
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
+# io.BytesIO is incorrectly converted to _io.BytesIO, this alias prevents that
+autodoc_type_aliases = {
+    "BytesIO": "~io.BytesIO",
+}
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']