From 4a15026bf5e1d6248f8e24b504005864bc747462 Mon Sep 17 00:00:00 2001 From: Inada Naoki Date: Wed, 17 May 2023 02:25:30 +0900 Subject: [PATCH 1/2] Fix sphinx warnings --- doc/MySQLdb.rst | 31 +++++++++++++------------------ doc/conf.py | 7 +++++++ src/MySQLdb/cursors.py | 2 +- 3 files changed, 21 insertions(+), 19 deletions(-) diff --git a/doc/MySQLdb.rst b/doc/MySQLdb.rst index 134a40b6..5e6791d5 100644 --- 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 index 5d8cd1a0..a639bbbb 100644 --- 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 index d3b2947b..7851359f 100644 --- 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( From 3ab6cf4e605ee2db9d2a4aef9d8f9c650b71a2b4 Mon Sep 17 00:00:00 2001 From: Inada Naoki Date: Wed, 17 May 2023 03:17:28 +0900 Subject: [PATCH 2/2] black --- doc/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index a639bbbb..3e919822 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -23,9 +23,9 @@ # -- General configuration ----------------------------------------------------- nitpick_ignore = [ - ('py:class', 'datetime.date'), - ('py:class', 'datetime.time'), - ('py:class', 'datetime.datetime'), + ("py:class", "datetime.date"), + ("py:class", "datetime.time"), + ("py:class", "datetime.datetime"), ]