summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-08-20 13:50:29 (GMT)
committerGitHub <noreply@github.com>2023-08-20 13:50:29 (GMT)
commitff125c4bd8694808892475ad6b63821fb7ea4338 (patch)
tree458c0e0d5231725f26847ac23f5a7cf1efc67283
parent590bc6a226f6425970197ff5c3a57beeaa99cdca (diff)
downloadcpython-ff125c4bd8694808892475ad6b63821fb7ea4338.zip
cpython-ff125c4bd8694808892475ad6b63821fb7ea4338.tar.gz
cpython-ff125c4bd8694808892475ad6b63821fb7ea4338.tar.bz2
[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@python.org>
-rw-r--r--Doc/license.rst10
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 5 insertions, 6 deletions
diff --git a/Doc/license.rst b/Doc/license.rst
index 812a0ad..1b20992 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 88ac905..d55b611 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