[Python-checkins] [3.12] Docs: Fix Sphinx warnings in license.rst (GH-108142) (#108167)

Yhg1s webhook-mailer at python.org
Sun Aug 20 09:50:32 EDT 2023


https://github.com/python/cpython/commit/ff125c4bd8694808892475ad6b63821fb7ea4338
commit: ff125c4bd8694808892475ad6b63821fb7ea4338
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Yhg1s <thomas at python.org>
date: 2023-08-20T15:50:29+02:00
summary:

[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 4d4393139fae39db26dead33529b6ae0bafbfc58)

Co-authored-by: Erlend E. Aasland <erlend at python.org>

files:
M Doc/license.rst
M Doc/tools/.nitignore

diff --git a/Doc/license.rst b/Doc/license.rst
index 812a0adffe1a4..1b209922b0952 100644
--- a/Doc/license.rst
+++ b/Doc/license.rst
@@ -352,8 +352,8 @@ the verbatim comments from the original code::
 Sockets
 -------
 
-The :mod:`socket` module uses the functions, :func:`getaddrinfo`, and
-:func:`getnameinfo`, which are coded in separate source files from the WIDE
+The :mod:`socket` module uses the functions, :c:func:`!getaddrinfo`, and
+:c:func:`!getnameinfo`, which are coded in separate source files from the WIDE
 Project, https://www.wide.ad.jp/. ::
 
    Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
@@ -387,7 +387,7 @@ Project, https://www.wide.ad.jp/. ::
 Asynchronous socket services
 ----------------------------
 
-The :mod:`test.support.asynchat` and :mod:`test.support.asyncore`
+The :mod:`!test.support.asynchat` and :mod:`!test.support.asyncore`
 modules contain the following notice::
 
    Copyright 1996 by Sam Rushing
@@ -539,7 +539,7 @@ The :mod:`xmlrpc.client` module contains the following notice::
 test_epoll
 ----------
 
-The :mod:`test_epoll` module contains the following notice::
+The :mod:`!test.test_epoll` module contains the following notice::
 
   Copyright (c) 2001-2006 Twisted Matrix Laboratories.
 
@@ -844,7 +844,7 @@ and later releases derived from that, the Apache License v2 applies::
 expat
 -----
 
-The :mod:`pyexpat` extension is built using an included copy of the expat
+The :mod:`pyexpat <xml.parsers.expat>` extension is built using an included copy of the expat
 sources unless the build is configured ``--with-system-expat``::
 
   Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 88ac905467299..d55b611a05575 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -176,7 +176,6 @@ Doc/library/xml.sax.rst
 Doc/library/xmlrpc.client.rst
 Doc/library/xmlrpc.server.rst
 Doc/library/zlib.rst
-Doc/license.rst
 Doc/reference/compound_stmts.rst
 Doc/reference/datamodel.rst
 Doc/reference/expressions.rst



More information about the Python-checkins mailing list