Fix sphinx warnings (#602)

Fix #539
PyMySQL · May 17, 2023 · 3517eb7 · 3517eb7
1 parent a2e9706
commit 3517eb7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 19 deletions.
diff --git a/doc/MySQLdb.rst b/doc/MySQLdb.rst
@@ -9,53 +9,48 @@ MySQLdb Package
     :undoc-members:
     :show-inheritance:
 
-:mod:`connections` Module
--------------------------
+:mod:`MySQLdb.connections` Module
+---------------------------------
 
 .. automodule:: MySQLdb.connections
     :members: Connection
     :undoc-members:
-    :show-inheritance:
 
-:mod:`converters` Module
-------------------------
+:mod:`MySQLdb.converters` Module
+--------------------------------
 
 .. automodule:: MySQLdb.converters
     :members:
     :undoc-members:
-    :show-inheritance:
 
-:mod:`cursors` Module
----------------------
+:mod:`MySQLdb.cursors` Module
+-----------------------------
 
 .. automodule:: MySQLdb.cursors
-    :members: Cursor
+    :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`times` Module
--------------------
+:mod:`MySQLdb.times` Module
+---------------------------
 
 .. automodule:: MySQLdb.times
     :members:
     :undoc-members:
-    :show-inheritance:
 
-:mod:`_mysql` Module
---------------------
+:mod:`MySQLdb._mysql` Module
+----------------------------
 
 .. automodule:: MySQLdb._mysql
     :members:
     :undoc-members:
-    :show-inheritance:
 
-:mod:`_exceptions` Module
--------------------------
+:mod:`MySQLdb._exceptions` Module
+---------------------------------
 
 .. automodule:: MySQLdb._exceptions
     :members:
     :undoc-members:
-    :show-inheritance:
 
 
 Subpackages

diff --git a/doc/conf.py b/doc/conf.py
@@ -22,6 +22,13 @@
 
 # -- General configuration -----------------------------------------------------
 
+nitpick_ignore = [
+    ("py:class", "datetime.date"),
+    ("py:class", "datetime.time"),
+    ("py:class", "datetime.datetime"),
+]
+
+
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = "1.0"
 

diff --git a/src/MySQLdb/cursors.py b/src/MySQLdb/cursors.py
@@ -8,7 +8,7 @@
 from ._exceptions import ProgrammingError
 
 
-#: Regular expression for :meth:`Cursor.executemany`.
+#: Regular expression for ``Cursor.executemany```.
 #: executemany only supports simple bulk insert.
 #: You can use it to load large dataset.
 RE_INSERT_VALUES = re.compile(