diff --git a/docs/html/development/architecture/upgrade-options.rst b/docs/html/development/architecture/upgrade-options.rst index 0527101f8c6..6196413ef93 100644 --- a/docs/html/development/architecture/upgrade-options.rst +++ b/docs/html/development/architecture/upgrade-options.rst @@ -34,18 +34,18 @@ relevant if ``--upgrade`` is specified. The base behaviour is to allow packages specified on pip's command line to be upgraded. This option controls what *other* packages can be upgraded: - * ``eager`` - all packages will be upgraded to the latest possible version. - It should be noted here that pip's current resolution algorithm isn't even - aware of packages other than those specified on the command line, and - those identified as dependencies. This may or may not be true of the new - resolver. - * ``only-if-needed`` - packages are only upgraded if they are named in the - pip command or a requirement file (i.e, they are direct requirements), or - an upgraded parent needs a later version of the dependency than is - currently installed. - * ``to-satisfy-only`` (**undocumented**) - packages are not upgraded (not - even direct requirements) unless the currently installed version fails to - satisfy a requirement (either explicitly specified or a dependency). +* ``eager`` - all packages will be upgraded to the latest possible version. + It should be noted here that pip's current resolution algorithm isn't even + aware of packages other than those specified on the command line, and + those identified as dependencies. This may or may not be true of the new + resolver. +* ``only-if-needed`` - packages are only upgraded if they are named in the + pip command or a requirement file (i.e, they are direct requirements), or + an upgraded parent needs a later version of the dependency than is + currently installed. +* ``to-satisfy-only`` (**undocumented**) - packages are not upgraded (not + even direct requirements) unless the currently installed version fails to + satisfy a requirement (either explicitly specified or a dependency). ``--force-reinstall`` diff --git a/docs/html/development/ci.rst b/docs/html/development/ci.rst index 7f214a3b84c..5befb316a4d 100644 --- a/docs/html/development/ci.rst +++ b/docs/html/development/ci.rst @@ -17,24 +17,24 @@ Supported interpreters pip support a variety of Python interpreters: - - CPython 2.7 - - CPython 3.5 - - CPython 3.6 - - CPython 3.7 - - CPython 3.8 - - Latest PyPy - - Latest PyPy3 +- CPython 2.7 +- CPython 3.5 +- CPython 3.6 +- CPython 3.7 +- CPython 3.8 +- Latest PyPy +- Latest PyPy3 on different operating systems: - - Linux - - Windows - - MacOS +- Linux +- Windows +- MacOS and on different architectures: - - x64 - - x86 +- x64 +- x86 so 42 hypothetical interpreters. @@ -66,9 +66,9 @@ Services pip test suite and checks are distributed on three different platforms that provides free executors for open source packages: - - `GitHub Actions`_ (Used for code quality and development tasks) - - `Azure DevOps CI`_ (Used for tests) - - `Travis CI`_ (Used for PyPy tests) +- `GitHub Actions`_ (Used for code quality and development tasks) +- `Azure DevOps CI`_ (Used for tests) +- `Travis CI`_ (Used for PyPy tests) .. _`Travis CI`: https://travis-ci.org/ .. _`Azure DevOps CI`: https://azure.microsoft.com/en-us/services/devops/ diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index 436ed241baf..94ff37fc32c 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -157,9 +157,9 @@ in order to start contributing. * A guide on `triaging issues`_ for issue tracker * Getting started with Git - - `Hello World for Git`_ - - `Understanding the GitHub flow`_ - - `Start using Git on the command line`_ + - `Hello World for Git`_ + - `Understanding the GitHub flow`_ + - `Start using Git on the command line`_ .. _`open an issue`: https://github.com/pypa/pip/issues/new?title=Trouble+with+pip+development+environment diff --git a/docs/html/development/issue-triage.rst b/docs/html/development/issue-triage.rst index a887bda62a8..9b5e5cc1c3e 100644 --- a/docs/html/development/issue-triage.rst +++ b/docs/html/development/issue-triage.rst @@ -276,16 +276,16 @@ An issue may be considered resolved and closed when: - for each possible improvement or problem represented in the issue discussion: - - Consensus has been reached on a specific action and the actions - appear to be external to the project, with no follow up needed - in the project afterwards. + - Consensus has been reached on a specific action and the actions + appear to be external to the project, with no follow up needed + in the project afterwards. - - PEP updates (with a corresponding issue in - `python/peps `__) - - already tracked by another issue + - PEP updates (with a corresponding issue in + `python/peps `__) + - already tracked by another issue - - A project-specific issue has been identified and the issue no - longer occurs as of the latest commit on the master branch. + - A project-specific issue has been identified and the issue no + longer occurs as of the latest commit on the master branch. - An enhancement or feature request no longer has a proponent and the maintainers don't think it's worth keeping open. @@ -305,8 +305,8 @@ Common issues manager-managed pip/python installation (specifically with Debian/Ubuntu). These typically present themselves as: - #. Not being able to find installed packages - #. basic libraries not able to be found, fundamental OS components missing - #. In these situations you will want to make sure that we know how they got - their Python and pip. Knowing the relevant package manager commands can - help, e.g. ``dpkg -S``. + #. Not being able to find installed packages + #. basic libraries not able to be found, fundamental OS components missing + #. In these situations you will want to make sure that we know how they got + their Python and pip. Knowing the relevant package manager commands can + help, e.g. ``dpkg -S``. diff --git a/docs/pip_sphinxext.py b/docs/pip_sphinxext.py index 9386d71e796..2486d5c33b9 100644 --- a/docs/pip_sphinxext.py +++ b/docs/pip_sphinxext.py @@ -143,7 +143,7 @@ def process_options(self): prefix = '{}_'.format(self.determine_opt_prefix(opt_name)) self.view_list.append( - ' * :ref:`{short}{long}<{prefix}{opt_name}>`'.format( + '* :ref:`{short}{long}<{prefix}{opt_name}>`'.format( short=short_opt_name, long=opt_name, prefix=prefix,