diff --git a/docs/html/development/ci.rst b/docs/html/development/ci.rst index 4e37f3d48..a953d046b 100644 --- a/docs/html/development/ci.rst +++ b/docs/html/development/ci.rst @@ -56,6 +56,7 @@ specified it's ok to require the latest CPython interpreter. So only unit tests and integration tests would need to be run with the different interpreters. + Services ======== diff --git a/docs/html/development/contributing.rst b/docs/html/development/contributing.rst index a82420da4..582f7f742 100644 --- a/docs/html/development/contributing.rst +++ b/docs/html/development/contributing.rst @@ -34,6 +34,7 @@ Examples include re-flowing text in comments or documentation, or addition or removal of blank lines or whitespace within lines. Such changes can be made separately, as a "formatting cleanup" PR, if needed. + Automated Testing ================= diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst index 4a43b52db..6fa4f9edc 100644 --- a/docs/html/development/getting-started.rst +++ b/docs/html/development/getting-started.rst @@ -8,6 +8,7 @@ This document is meant to get you setup to work on pip and to act as a guide and reference to the development setup. If you face any issues during this process, please `open an issue`_ about it on the issue tracker. + Get the source code =================== @@ -29,6 +30,7 @@ you should `install Python`_ on your computer. For developing pip, you need to install :pypi:`tox`. Often, you can run ``python -m pip install tox`` to install and use it. + Running pip From Source Tree ============================ @@ -39,6 +41,7 @@ from the ``src`` directory: $ python src/pip --version + Running Tests ============= @@ -84,6 +87,7 @@ tools, you can tell pip to skip those tests: $ tox -e py36 -- -k "not svn" $ tox -e py36 -- -k "not (svn or git)" + Running Linters =============== @@ -104,6 +108,7 @@ To use linters locally, run: reserved for rare cases where the recommended style causes severe readability problems. + Building Documentation ====================== diff --git a/docs/html/index.rst b/docs/html/index.rst index 1b9056196..1df75855b 100644 --- a/docs/html/index.rst +++ b/docs/html/index.rst @@ -28,6 +28,7 @@ If you want to get involved head over to GitHub to get the source code and feel * `Dev mailing list`_ * `Dev IRC`_ + Code of Conduct =============== diff --git a/docs/html/reference/pip.rst b/docs/html/reference/pip.rst index 676869a46..7907f973b 100644 --- a/docs/html/reference/pip.rst +++ b/docs/html/reference/pip.rst @@ -18,6 +18,7 @@ Description .. _`Logging`: + Logging ======= @@ -69,6 +70,7 @@ when decision is needed. .. _`build-interface`: + Build System Interface ====================== diff --git a/docs/html/reference/pip_check.rst b/docs/html/reference/pip_check.rst index e106f1a37..a12d5b3ec 100644 --- a/docs/html/reference/pip_check.rst +++ b/docs/html/reference/pip_check.rst @@ -6,6 +6,7 @@ pip check .. contents:: + Usage ===== diff --git a/docs/html/reference/pip_config.rst b/docs/html/reference/pip_config.rst index 506a95427..70d9406c5 100644 --- a/docs/html/reference/pip_config.rst +++ b/docs/html/reference/pip_config.rst @@ -7,16 +7,19 @@ pip config .. contents:: + Usage ===== .. pip-command-usage:: config + Description =========== .. pip-command-description:: config + Options ======= diff --git a/docs/html/reference/pip_debug.rst b/docs/html/reference/pip_debug.rst index 05478e984..b89e531dd 100644 --- a/docs/html/reference/pip_debug.rst +++ b/docs/html/reference/pip_debug.rst @@ -6,6 +6,7 @@ pip debug .. contents:: + Usage ===== diff --git a/docs/html/reference/pip_download.rst b/docs/html/reference/pip_download.rst index ab2611e17..a1b4e51ee 100644 --- a/docs/html/reference/pip_download.rst +++ b/docs/html/reference/pip_download.rst @@ -7,6 +7,7 @@ pip download .. contents:: + Usage ===== diff --git a/docs/html/reference/pip_freeze.rst b/docs/html/reference/pip_freeze.rst index 8a4e954ed..31efd571b 100644 --- a/docs/html/reference/pip_freeze.rst +++ b/docs/html/reference/pip_freeze.rst @@ -7,6 +7,7 @@ pip freeze .. contents:: + Usage ===== diff --git a/docs/html/reference/pip_hash.rst b/docs/html/reference/pip_hash.rst index 468ecff42..6320a9ab6 100644 --- a/docs/html/reference/pip_hash.rst +++ b/docs/html/reference/pip_hash.rst @@ -6,6 +6,7 @@ pip hash .. contents:: + Usage ===== diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index a188d7a4b..6867a98ce 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -6,11 +6,13 @@ pip install .. contents:: + Usage ===== .. pip-command-usage:: install + Description =========== diff --git a/docs/html/reference/pip_list.rst b/docs/html/reference/pip_list.rst index 3930dd2e5..15d0920a7 100644 --- a/docs/html/reference/pip_list.rst +++ b/docs/html/reference/pip_list.rst @@ -6,16 +6,19 @@ pip list .. contents:: + Usage ===== .. pip-command-usage:: list + Description =========== .. pip-command-description:: list + Options ======= diff --git a/docs/html/reference/pip_search.rst b/docs/html/reference/pip_search.rst index bbc9fcf95..db1bd2be8 100644 --- a/docs/html/reference/pip_search.rst +++ b/docs/html/reference/pip_search.rst @@ -6,6 +6,7 @@ pip search .. contents:: + Usage ===== @@ -17,6 +18,7 @@ Description .. pip-command-description:: search + Options ======= diff --git a/docs/html/reference/pip_uninstall.rst b/docs/html/reference/pip_uninstall.rst index f25c4361f..67d752d6b 100644 --- a/docs/html/reference/pip_uninstall.rst +++ b/docs/html/reference/pip_uninstall.rst @@ -6,16 +6,19 @@ pip uninstall .. contents:: + Usage ===== .. pip-command-usage:: uninstall + Description =========== .. pip-command-description:: uninstall + Options ======= diff --git a/docs/html/reference/pip_wheel.rst b/docs/html/reference/pip_wheel.rst index df14dc037..dc32dda46 100644 --- a/docs/html/reference/pip_wheel.rst +++ b/docs/html/reference/pip_wheel.rst @@ -7,6 +7,7 @@ pip wheel .. contents:: + Usage ===== diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index ff4384f0d..4ebccd5dd 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -4,6 +4,7 @@ User Guide .. contents:: + Running pip =========== @@ -97,6 +98,7 @@ pip can be configured to connect through a proxy server in various ways: .. _`Requirements Files`: + Requirements Files ================== @@ -179,6 +181,7 @@ See also: .. _`Constraints Files`: + Constraints Files ================= @@ -213,6 +216,7 @@ Constraints file support was added in pip 7.1. .. _`Installing from Wheels`: + Installing from Wheels ====================== @@ -325,6 +329,7 @@ For more information and examples, see the :ref:`pip search` reference. .. _`Configuration`: + Configuration ============= @@ -523,6 +528,7 @@ startup file:: .. _`Installing from local packages`: + Installing from local packages ============================== @@ -669,6 +675,7 @@ is the latest version:: .. _`Repeatability`: + Ensuring Repeatability ====================== @@ -754,6 +761,7 @@ archives are built with identical packages. .. _`Using pip from your program`: + Using pip from your program ===========================