Skip to content

Fix sphinx warnings #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 17, 2023
Merged

Fix sphinx warnings #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a15026
Fix sphinx warnings
methane May 16, 2023
3ab6cf4
black
methane May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions doc/MySQLdb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
2 changes: 1 addition & 1 deletion src/MySQLdb/cursors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down