Skip to content

Commit ff125c4

Browse files
[3.12] Docs: Fix Sphinx warnings in license.rst (GH-108142) (#108167)
Docs: Fix Sphinx warnings in license.rst (GH-108142) - Fix links to stdlib modules - Silence links to external functions (cherry picked from commit 4d43931) Co-authored-by: Erlend E. Aasland <[email protected]>
1 parent 590bc6a commit ff125c4

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

Doc/license.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -352,8 +352,8 @@ the verbatim comments from the original code::
352352
Sockets
353353
-------
354354

355-
The :mod:`socket` module uses the functions, :func:`getaddrinfo`, and
356-
:func:`getnameinfo`, which are coded in separate source files from the WIDE
355+
The :mod:`socket` module uses the functions, :c:func:`!getaddrinfo`, and
356+
:c:func:`!getnameinfo`, which are coded in separate source files from the WIDE
357357
Project, https://www.wide.ad.jp/. ::
358358

359359
Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
@@ -387,7 +387,7 @@ Project, https://www.wide.ad.jp/. ::
387387
Asynchronous socket services
388388
----------------------------
389389

390-
The :mod:`test.support.asynchat` and :mod:`test.support.asyncore`
390+
The :mod:`!test.support.asynchat` and :mod:`!test.support.asyncore`
391391
modules contain the following notice::
392392

393393
Copyright 1996 by Sam Rushing
@@ -539,7 +539,7 @@ The :mod:`xmlrpc.client` module contains the following notice::
539539
test_epoll
540540
----------
541541

542-
The :mod:`test_epoll` module contains the following notice::
542+
The :mod:`!test.test_epoll` module contains the following notice::
543543

544544
Copyright (c) 2001-2006 Twisted Matrix Laboratories.
545545

@@ -844,7 +844,7 @@ and later releases derived from that, the Apache License v2 applies::
844844
expat
845845
-----
846846

847-
The :mod:`pyexpat` extension is built using an included copy of the expat
847+
The :mod:`pyexpat <xml.parsers.expat>` extension is built using an included copy of the expat
848848
sources unless the build is configured ``--with-system-expat``::
849849

850850
Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd

Doc/tools/.nitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,6 @@ Doc/library/xml.sax.rst
176176
Doc/library/xmlrpc.client.rst
177177
Doc/library/xmlrpc.server.rst
178178
Doc/library/zlib.rst
179-
Doc/license.rst
180179
Doc/reference/compound_stmts.rst
181180
Doc/reference/datamodel.rst
182181
Doc/reference/expressions.rst

0 commit comments

Comments
 (0)