Skip to content

Commit d14697d

Browse files
Updates to PyManager docs based on feedback. (GH-142473)
(cherry picked from commit 37fe9a9) Co-authored-by: Steve Dower <[email protected]>
1 parent 1e495c2 commit d14697d

File tree

1 file changed

+40
-7
lines changed

1 file changed

+40
-7
lines changed

Doc/using/windows.rst

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -290,8 +290,12 @@ Passing ``--dry-run`` will generate output and logs, but will not modify any
290290
installs.
291291

292292
In addition to the above options, the ``--target`` option will extract the
293-
runtime to the specified directory instead of doing a normal install. This is
294-
useful for embedding runtimes into larger applications.
293+
runtime to the specified directory instead of doing a normal install.
294+
This is useful for embedding runtimes into larger applications.
295+
Unlike a normal install, ``py`` will not be aware of the extracted runtime,
296+
and no Start menu or other shortcuts will be created.
297+
To launch the runtime, directly execute the main executable (typically
298+
``python.exe``) in the target directory.
295299

296300
.. code::
297301
@@ -378,10 +382,13 @@ overridden installs may resolve settings differently.
378382

379383
A global configuration file may be configured by an administrator, and would be
380384
read first. The user configuration file is stored at
381-
:file:`%AppData%\\Python\\pymanager.json` (by default) and is read next,
385+
:file:`%AppData%\\Python\\pymanager.json`
386+
(note that this location is under ``Roaming``, not ``Local``) and is read next,
382387
overwriting any settings from earlier files. An additional configuration file
383388
may be specified as the ``PYTHON_MANAGER_CONFIG`` environment variable or the
384389
``--config`` command line option (but not both).
390+
These locations may be modified by administrative customization options listed
391+
later.
385392

386393
The following settings are those that are considered likely to be modified in
387394
normal use. Later sections list those that are intended for administrative
@@ -420,8 +427,8 @@ customization.
420427

421428
* - ``automatic_install``
422429
- ``PYTHON_MANAGER_AUTOMATIC_INSTALL``
423-
- True to allow automatic installs when specifying a particular runtime
424-
to launch.
430+
- True to allow automatic installs when using ``py exec`` to launch.
431+
Other commands will not automatically install.
425432
By default, true.
426433

427434
* - ``include_unmanaged``
@@ -799,6 +806,12 @@ default).
799806
* -
800807
- Check that the ``py`` and ``pymanager`` commands work.
801808

809+
* -
810+
- Ensure your :envvar:`PATH` variable contains the entry for
811+
``%UserProfile%\AppData\Local\Microsoft\WindowsApps``.
812+
The operating system includes this entry once by default, after other
813+
user paths. If removed, shortcuts will not be found.
814+
802815
* - ``py`` gives me a "command not found" error when I type it in my terminal.
803816
- Did you :ref:`install the Python install manager <pymanager>`?
804817

@@ -809,6 +822,12 @@ default).
809822
The "Python (default windowed)" and "Python install manager" commands
810823
may also need refreshing.
811824

825+
* -
826+
- Ensure your :envvar:`PATH` variable contains the entry for
827+
``%UserProfile%\AppData\Local\Microsoft\WindowsApps``.
828+
The operating system includes this entry once by default, after other
829+
user paths. If removed, shortcuts will not be found.
830+
812831
* - ``py`` gives me a "can't open file" error when I type commands in my
813832
terminal.
814833
- This usually means you have the legacy launcher installed and
@@ -839,7 +858,7 @@ default).
839858
- Prerelease and experimental installs that are not managed by the Python
840859
install manager may be chosen ahead of stable releases.
841860
Configure your default tag or uninstall the prerelease runtime
842-
and reinstall using ``py install``.
861+
and reinstall it using ``py install``.
843862

844863
* - ``pythonw`` or ``pyw`` don't launch the same runtime as ``python`` or ``py``
845864
- Click Start, open "Manage app execution aliases", and check that your
@@ -869,6 +888,20 @@ default).
869888
the `legacy launcher`_, or with the Python install manager when installed
870889
from the MSI.
871890

891+
* - I have installed the Python install manager multiple times.
892+
- It is possible to install from the Store or WinGet, from the MSIX on
893+
the Python website, and from the MSI, all at once.
894+
They are all compatible and will share configuration and runtimes.
895+
896+
* -
897+
- See the earlier :ref:`pymanager-advancedinstall` section for ways to
898+
uninstall the install manager other than the typical Installed Apps
899+
(Add and Remove Programs) settings page.
900+
901+
* - My old ``py.ini`` settings no longer work.
902+
- The new Python install manager no longer supports this configuration file
903+
or its settings, and so it will be ignored.
904+
See :ref:`pymanager-config` for information about configuration settings.
872905

873906
.. _windows-embeddable:
874907

@@ -886,7 +919,7 @@ To install an embedded distribution, we recommend using ``py install`` with the
886919

887920
.. code::
888921
889-
$> py install 3.14-embed --target=runtime
922+
$> py install 3.14-embed --target=<directory>
890923
891924
When extracted, the embedded distribution is (almost) fully isolated from the
892925
user's system, including environment variables, system registry settings, and

0 commit comments

Comments
 (0)