https://github.com/python/cpython/commit/424e2ab95a0b225effa4ec1057be467bf696f75e
commit: 424e2ab95a0b225effa4ec1057be467bf696f75e
branch: main
author: Adam Turner <[email protected]>
committer: AA-Turner <[email protected]>
date: 2025-09-03T17:18:21+01:00
summary:
GH-101100: Resolve reference warnings in using/windows.rst (#138416)
files:
M Doc/tools/.nitignore
M Doc/using/windows.rst
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 475c9f6613aef3..64fda9d26c655b 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -56,7 +56,6 @@ Doc/library/xmlrpc.server.rst
Doc/library/zlib.rst
Doc/reference/compound_stmts.rst
Doc/reference/datamodel.rst
-Doc/using/windows.rst
Doc/whatsnew/2.4.rst
Doc/whatsnew/2.5.rst
Doc/whatsnew/2.6.rst
diff --git a/Doc/using/windows.rst b/Doc/using/windows.rst
index c66308e61e89da..2cfdeac10f647f 100644
--- a/Doc/using/windows.rst
+++ b/Doc/using/windows.rst
@@ -398,7 +398,7 @@ customization.
- Description
* - ``default_tag``
- - ``PYTHON_MANAGER_DEFAULT``
+ - .. envvar:: PYTHON_MANAGER_DEFAULT
- The preferred default version to launch or install.
By default, this is interpreted as the most recent non-prerelease
version
from the CPython team.
@@ -812,7 +812,7 @@ default).
``python.exe`` alias is set to "Python (default)"
* - ``python`` and ``py`` don't launch the runtime I expect
- - Check your ``PYTHON_MANAGER_DEFAULT`` environment variable
+ - Check your :envvar:`PYTHON_MANAGER_DEFAULT` environment variable
or ``default_tag`` configuration.
The ``py list`` command will show your default based on these settings.
@@ -1802,7 +1802,7 @@ program, which performs a :envvar:`PATH` search.
If an executable matching the first argument after the ``env`` command cannot
be found, but the argument starts with ``python``, it will be handled as
described for the other virtual commands.
-The environment variable :envvar:`PYLAUNCHER_NO_SEARCH_PATH` may be set
+The environment variable :envvar:`!PYLAUNCHER_NO_SEARCH_PATH` may be set
(to any value) to skip this search of :envvar:`PATH`.
Shebang lines that do not match any of these patterns are looked up in the
@@ -1869,7 +1869,7 @@ For example, a shebang line of ``#!python`` has no
version qualifier, while
``#!python3`` has a version qualifier which specifies only a major version.
If no version qualifiers are found in a command, the environment
-variable :envvar:`PY_PYTHON` can be set to specify the default version
+variable :envvar:`!PY_PYTHON` can be set to specify the default version
qualifier. If it is not set, the default is "3". The variable can
specify any value that may be passed on the command line, such as "3",
"3.7", "3.7-32" or "3.7-64". (Note that the "-64" option is only
@@ -1942,7 +1942,7 @@ For example:
Diagnostics
-----------
-If an environment variable :envvar:`PYLAUNCHER_DEBUG` is set (to any value),
the
+If an environment variable :envvar:`!PYLAUNCHER_DEBUG` is set (to any value),
the
launcher will print diagnostic information to stderr (i.e. to the console).
While this information manages to be simultaneously verbose *and* terse, it
should allow you to see what versions of Python were located, why a
@@ -1952,7 +1952,7 @@ target Python. It is primarily intended for testing and
debugging.
Dry Run
-------
-If an environment variable :envvar:`PYLAUNCHER_DRYRUN` is set (to any value),
+If an environment variable :envvar:`!PYLAUNCHER_DRYRUN` is set (to any value),
the launcher will output the command it would have run, but will not actually
launch Python. This may be useful for tools that want to use the launcher to
detect and then launch Python directly. Note that the command written to
@@ -1962,14 +1962,14 @@ the console.
Install on demand
-----------------
-If an environment variable :envvar:`PYLAUNCHER_ALLOW_INSTALL` is set (to any
+If an environment variable :envvar:`!PYLAUNCHER_ALLOW_INSTALL` is set (to any
value), and the requested Python version is not installed but is available on
the Microsoft Store, the launcher will attempt to install it. This may require
user interaction to complete, and you may need to run the command again.
-An additional :envvar:`PYLAUNCHER_ALWAYS_INSTALL` variable causes the launcher
+An additional :envvar:`!PYLAUNCHER_ALWAYS_INSTALL` variable causes the launcher
to always try to install Python, even if it is detected. This is mainly
intended
-for testing (and should be used with :envvar:`PYLAUNCHER_DRYRUN`).
+for testing (and should be used with :envvar:`!PYLAUNCHER_DRYRUN`).
Return codes
------------
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
