From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Wed, 27 Sep 2023 00:35:26 +0000 (-0700) Subject: [3.11] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (#109938) X-Git-Tag: v3.11.6~38 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c485715ba884ebfbcbad7a0ab01a8dc933f74d2b;p=thirdparty%2FPython%2Fcpython.git [3.11] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (#109938) gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (cherry picked from commit 3538930d87e6bdd2bfffa3f674a62cc91d359d31) Co-authored-by: Victor Stinner --- diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 1c17a3f2bd2c..49566e61cdc3 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -156,7 +156,6 @@ Doc/tutorial/controlflow.rst Doc/tutorial/datastructures.rst Doc/tutorial/introduction.rst Doc/using/cmdline.rst -Doc/using/configure.rst Doc/using/windows.rst Doc/whatsnew/2.0.rst Doc/whatsnew/2.1.rst diff --git a/Doc/using/configure.rst b/Doc/using/configure.rst index c2b2dee5615b..6e4a43f4aadc 100644 --- a/Doc/using/configure.rst +++ b/Doc/using/configure.rst @@ -18,8 +18,8 @@ General Options .. cmdoption:: --enable-loadable-sqlite-extensions - Support loadable extensions in the :mod:`_sqlite` extension module (default - is no). + Support loadable extensions in the :mod:`!_sqlite` extension module (default + is no) of the :mod:`sqlite3` module. See the :meth:`sqlite3.Connection.enable_load_extension` method of the :mod:`sqlite3` module. @@ -117,7 +117,7 @@ General Options Some Linux distribution packaging policies recommend against bundling dependencies. For example, Fedora installs wheel packages in the ``/usr/share/python-wheels/`` directory and don't install the - :mod:`ensurepip._bundled` package. + :mod:`!ensurepip._bundled` package. .. versionadded:: 3.10 @@ -193,7 +193,7 @@ Install Options .. cmdoption:: --disable-test-modules Don't build nor install test modules, like the :mod:`test` package or the - :mod:`_testcapi` extension module (built and installed by default). + :mod:`!_testcapi` extension module (built and installed by default). .. versionadded:: 3.10 @@ -292,7 +292,7 @@ Effects of a debug build: * Display all warnings by default: the list of default warning filters is empty in the :mod:`warnings` module. * Add ``d`` to :data:`sys.abiflags`. -* Add :func:`sys.gettotalrefcount` function. +* Add :func:`!sys.gettotalrefcount` function. * Add :option:`-X showrefcount <-X>` command line option. * Add :envvar:`PYTHONTHREADDEBUG` environment variable. * Add support for the ``__lltrace__`` variable: enable low-level tracing in the @@ -313,7 +313,7 @@ Effects of a debug build: * Check that deallocator functions don't change the current exception. * The garbage collector (:func:`gc.collect` function) runs some basic checks on objects consistency. - * The :c:macro:`Py_SAFE_DOWNCAST()` macro checks for integer underflow and + * The :c:macro:`!Py_SAFE_DOWNCAST()` macro checks for integer underflow and overflow when downcasting from wide types to narrow types. See also the :ref:`Python Development Mode ` and the @@ -341,7 +341,7 @@ Debug options Effects: * Define the ``Py_TRACE_REFS`` macro. - * Add :func:`sys.getobjects` function. + * Add :func:`!sys.getobjects` function. * Add :envvar:`PYTHONDUMPREFS` environment variable. This build is not ABI compatible with release build (default build) or debug @@ -419,7 +419,7 @@ Libraries options .. cmdoption:: --with-system-expat - Build the :mod:`pyexpat` module using an installed ``expat`` library + Build the :mod:`!pyexpat` module using an installed ``expat`` library (default is no). .. cmdoption:: --with-system-ffi