Skip to content

Commit eb0c61f

Browse files
committed
Formatting; headers
1 parent d7609a6 commit eb0c61f

File tree

1 file changed

+80
-66
lines changed

1 file changed

+80
-66
lines changed

Doc/using/windows.rst

Lines changed: 80 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -391,50 +391,61 @@ customization.
391391
.. rubric:: Standard configuration options
392392

393393
.. list-table::
394+
:header-rows: 1
394395

395396
* - Config Key
396397
- Environment Variable
397398
- Description
398399

399400
* - ``default_tag``
400401
- ``PYTHON_MANAGER_DEFAULT``
401-
- The preferred default version to launch or install. By default, this is interpreted as the most recent non-prerelease version from the CPython team.
402+
- The preferred default version to launch or install.
403+
By default, this is interpreted as the most recent non-prerelease version
404+
from the CPython team.
402405

403406
* - ``default_platform``
404407
- ``PYTHON_MANAGER_DEFAULT_PLATFORM``
405-
- The preferred default platform to launch or install. This is treated as a suffix to the
406-
specified tag, such that ``py -V:3.14`` would prefer an install for
407-
``3.14-64`` if it exists (and ``default_platform`` is ``-64``), but will use
408-
``3.14`` if no tagged install exists.
408+
- The preferred default platform to launch or install.
409+
This is treated as a suffix to the specified tag, such that ``py -V:3.14``
410+
would prefer an install for ``3.14-64`` if it exists
411+
(and ``default_platform`` is ``-64``),
412+
but will use ``3.14`` if no tagged install exists.
409413

410414
* - ``logs_dir``
411415
- ``PYTHON_MANAGER_LOGS``
412-
- The location where log files are written. By default, :file:`%TEMP%`.
416+
- The location where log files are written.
417+
By default, :file:`%TEMP%`.
413418

414419
* - ``automatic_install``
415420
- ``PYTHON_MANAGER_AUTOMATIC_INSTALL``
416-
- True to allow automatic installs when specifying a particular runtime to launch.
421+
- True to allow automatic installs when specifying a particular runtime
422+
to launch.
417423
By default, true.
418424

419425
* - ``include_unmanaged``
420426
- ``PYTHON_MANAGER_INCLUDE_UNMANAGED``
421-
- True to allow listing and launching runtimes that were not installed by the Python
422-
install manager, or false to exclude them. By default, true.
427+
- True to allow listing and launching runtimes that were not installed
428+
by the Python install manager, or false to exclude them.
429+
By default, true.
423430

424431
* - ``shebang_can_run_anything``
425432
- ``PYTHON_MANAGER_SHEBANG_CAN_RUN_ANYTHING``
426433
- True to allow shebangs in ``.py`` files to launch applications other than
427-
Python runtimes, or false to prevent it. By default, true.
434+
Python runtimes, or false to prevent it.
435+
By default, true.
428436

429437
* - ``log_level``
430438
- ``PYMANAGER_VERBOSE``, ``PYMANAGER_DEBUG``
431-
- Set the default level of output (0-50) By default, 20. Lower values produce more
432-
output. The environment variables are boolean, and may produce additional
439+
- Set the default level of output (0-50).
440+
By default, 20.
441+
Lower values produce more output.
442+
The environment variables are boolean, and may produce additional
433443
output during startup that is later suppressed by other configuration.
434444

435445
* - ``confirm``
436446
- ``PYTHON_MANAGER_CONFIRM``
437-
- True to confirm certain actions before taking them (such as uninstall), or false to skip the confirmation.
447+
- True to confirm certain actions before taking them (such as uninstall),
448+
or false to skip the confirmation.
438449
By default, true.
439450

440451
* - ``install.source``
@@ -660,14 +671,15 @@ directory containing the configuration file that specified them.
660671
.. rubric:: Administrative configuration options
661672

662673
.. list-table::
674+
:header-rows: 1
663675

664676
* - Config Key
665677
- Description
666678

667679
* - ``base_config``
668-
- The highest priority configuration file to read. Note that
669-
only the built-in configuration file and the registry can modify this
670-
setting.
680+
- The highest priority configuration file to read.
681+
Note that only the built-in configuration file and the registry can
682+
modify this setting.
671683

672684
* - ``user_config``
673685
- The second configuration file to read.
@@ -676,41 +688,41 @@ directory containing the configuration file that specified them.
676688
- The third configuration file to read.
677689

678690
* - ``registry_override_key``
679-
- Registry location to check for overrides. Note
680-
that only the built-in configuration file can modify this setting.
691+
- Registry location to check for overrides.
692+
Note that only the built-in configuration file can modify this setting.
681693

682694
* - ``bundled_dir``
683695
- Read-only directory containing locally cached files.
684696

685697
* - ``install.fallback_source``
686-
- Path or URL to an index to consult when the
687-
main index cannot be accessed.
698+
- Path or URL to an index to consult when the main index cannot be accessed.
688699

689700
* - ``install.enable_shortcut_kinds``
690-
- Comma-separated list of shortcut kinds
691-
to allow (e.g. ``"pep514,start"``). Enabled shortcuts may still be disabled
692-
by ``disable_shortcut_kinds``.
701+
- Comma-separated list of shortcut kinds to allow (e.g. ``"pep514,start"``).
702+
Enabled shortcuts may still be disabled by ``disable_shortcut_kinds``.
693703

694704
* - ``install.disable_shortcut_kinds``
695-
- Comma-separated list of shortcut kinds
696-
to exclude (e.g. ``"pep514,start"``). Disabled shortcuts are not
697-
reactivated by ``enable_shortcut_kinds``.
705+
- Comma-separated list of shortcut kinds to exclude
706+
(e.g. ``"pep514,start"``).
707+
Disabled shortcuts are not reactivated by ``enable_shortcut_kinds``.
698708

699709
* - ``pep514_root``
700710
- Registry location to read and write PEP 514 entries into.
701711
By default, :file:`HKEY_CURRENT_USER\\Software\\Python`.
702712

703713
* - ``start_folder``
704-
- Start menu folder to write shortcuts into. By default,
705-
``Python``. This path is relative to the user's Programs folder.
714+
- Start menu folder to write shortcuts into.
715+
By default, ``Python``.
716+
This path is relative to the user's Programs folder.
706717

707718
* - ``virtual_env``
708-
- Path to the active virtual environment. By default, this
709-
is ``%VIRTUAL_ENV%``, but may be set empty to disable venv detection.
719+
- Path to the active virtual environment.
720+
By default, this is ``%VIRTUAL_ENV%``, but may be set empty
721+
to disable venv detection.
710722

711723
* - ``shebang_can_run_anything_silently``
712-
- True to suppress visible warnings
713-
when a shebang launches an application other than a Python runtime.
724+
- True to suppress visible warnings when a shebang launches an application
725+
other than a Python runtime.
714726

715727
.. _install-freethreaded-windows:
716728

@@ -755,6 +767,7 @@ default).
755767
.. rubric:: Troubleshooting
756768

757769
.. list-table::
770+
:header-rows: 1
758771

759772
* - Symptom
760773
- Things to try
@@ -765,71 +778,72 @@ default).
765778

766779
* -
767780
- Click Start, open "Manage app execution aliases", and check that the
768-
aliases for "Python (default)" are enabled. If they already are, try
769-
disabling and re-enabling to refresh the command. The "Python (default
770-
windowed)" and "Python install manager" commands may also need refreshing.
781+
aliases for "Python (default)" are enabled.
782+
If they already are, try disabling and re-enabling to refresh the command.
783+
The "Python (default windowed)" and "Python install manager" commands
784+
may also need refreshing.
771785

772786
* -
773787
- Check that the ``py`` and ``pymanager`` commands work.
774788

775-
* - ``py`` gives me a "command not found" error when I type it in my
776-
terminal.
789+
* - ``py`` gives me a "command not found" error when I type it in my terminal.
777790
- Did you :ref:`install the Python install manager <pymanager>`?
778791

779792
* -
780793
- Click Start, open "Manage app execution aliases", and check that the
781-
aliases for "Python install manager" are enabled. If they already are, try
782-
disabling and re-enabling to refresh the command. The "Python (default
783-
windowed)" and "Python install manager" commands may also need refreshing.
794+
aliases for "Python (default)" are enabled.
795+
If they already are, try disabling and re-enabling to refresh the command.
796+
The "Python (default windowed)" and "Python install manager" commands
797+
may also need refreshing.
784798

785799
* - ``py`` gives me a "can't open file" error when I type commands in my
786800
terminal.
787-
- This usually means you have the legacy launcher installed and it
788-
has priority over the Python install manager. To remove, click Start, open
789-
"Installed apps", search for "Python launcher" and uninstall it.
801+
- This usually means you have the legacy launcher installed and
802+
it has priority over the Python install manager.
803+
To remove, click Start, open "Installed apps",
804+
search for "Python launcher" and uninstall it.
790805

791806
* - ``python`` doesn't launch the same runtime as ``py``
792-
- Click Start, open
793-
"Installed apps", look for any existing Python runtimes, and either remove
794-
them or Modify and disable the :envvar:`PATH` options.
807+
- Click Start, open "Installed apps", look for any existing Python runtimes,
808+
and either remove them or Modify and disable the :envvar:`PATH` options.
795809

796810
* -
797811
- Click Start, open "Manage app execution aliases", and check that your
798812
``python.exe`` alias is set to "Python (default)"
799813

800814
* - ``python`` and ``py`` don't launch the runtime I expect
801-
- Check your
802-
``PYTHON_MANAGER_DEFAULT`` environment variable or ``default_tag``
803-
configuration. The ``py list`` command will show your default based on these
804-
settings.
815+
- Check your ``PYTHON_MANAGER_DEFAULT`` environment variable
816+
or ``default_tag`` configuration.
817+
The ``py list`` command will show your default based on these settings.
805818

806819
* -
807820
- Installs that are managed by the Python install manager will be chosen
808-
ahead of unmanaged installs. Use ``py install`` to install the runtime you
809-
expect, or configure your default tag.
821+
ahead of unmanaged installs.
822+
Use ``py install`` to install the runtime you expect,
823+
or configure your default tag.
810824

811825
* -
812826
- Prerelease and experimental installs that are not managed by the Python
813-
install manager may be chosen ahead of stable releases. Configure your
814-
default tag or uninstall the prerelease runtime and reinstall using ``py
815-
install``.
827+
install manager may be chosen ahead of stable releases.
828+
Configure your default tag or uninstall the prerelease runtime
829+
and reinstall using ``py install``.
816830

817-
* - ``pythonw`` or ``pyw`` don't launch the same runtime as ``python`` or
818-
``py``
819-
- Click Start, open "Manage app execution aliases", and check that
820-
your ``pythonw.exe`` and ``pyw.exe`` aliases are consistent with your
821-
others.
831+
* - ``pythonw`` or ``pyw`` don't launch the same runtime as ``python`` or ``py``
832+
- Click Start, open "Manage app execution aliases", and check that your
833+
``pythonw.exe`` and ``pyw.exe`` aliases are consistent with your others.
822834

823835
* - ``pip`` gives me a "command not found" error when I type it in my terminal.
824-
- Have you activated a virtual environment? Run the
825-
``.venv\Scripts\activate`` script in your terminal to activate.
836+
- Have you activated a virtual environment?
837+
Run the ``.venv\Scripts\activate`` script in your terminal to activate.
826838

827839
* -
828840
- The package may be available but missing the generated executable.
829-
We recommend using the ``python -m pip`` command instead, or alternatively
830-
the ``python -m pip install --force pip`` command will recreate the
831-
executables and show you the path to add to :envvar:`PATH`. These scripts are
832-
separated for each runtime, and so you may need to add multiple paths.
841+
We recommend using the ``python -m pip`` command instead,
842+
or alternatively the ``python -m pip install --force pip`` command
843+
will recreate the executables and show you the path to
844+
add to :envvar:`PATH`.
845+
These scripts are separated for each runtime, and so you may need to
846+
add multiple paths.
833847

834848

835849
.. _windows-embeddable:

0 commit comments

Comments
 (0)