From 2d87d5f6891a4de0295616285331851e398517f8 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Tue, 11 Feb 2020 18:40:42 +0530 Subject: [PATCH] Enforce blank lines before directive-blocks --- docs/html/development/architecture/anatomy.rst | 1 + docs/html/development/architecture/index.rst | 2 ++ docs/html/development/architecture/overview.rst | 1 + docs/html/development/ci.rst | 1 + docs/html/development/issue-triage.rst | 1 + docs/html/reference/pip_debug.rst | 1 + docs/html/reference/pip_install.rst | 3 +++ docs/html/user_guide.rst | 1 + 8 files changed, 11 insertions(+) diff --git a/docs/html/development/architecture/anatomy.rst b/docs/html/development/architecture/anatomy.rst index 741535845..4fcdeca77 100644 --- a/docs/html/development/architecture/anatomy.rst +++ b/docs/html/development/architecture/anatomy.rst @@ -1,4 +1,5 @@ .. note:: + This section of the documentation is currently being written. pip developers welcome your help to complete this documentation. If you're interested in helping out, please let us know in the `tracking issue`_. diff --git a/docs/html/development/architecture/index.rst b/docs/html/development/architecture/index.rst index 782cc02a7..094adeede 100644 --- a/docs/html/development/architecture/index.rst +++ b/docs/html/development/architecture/index.rst @@ -3,11 +3,13 @@ Architecture of pip's internals =============================== .. note:: + This section of the documentation is currently being written. pip developers welcome your help to complete this documentation. If you're interested in helping out, please let us know in the `tracking issue`_. .. note:: + Direct use of pip's internals is *not supported*, and these internals can change at any time. For more details, see :ref:`Using pip from your program`. diff --git a/docs/html/development/architecture/overview.rst b/docs/html/development/architecture/overview.rst index c83600b8b..1847a04de 100644 --- a/docs/html/development/architecture/overview.rst +++ b/docs/html/development/architecture/overview.rst @@ -1,4 +1,5 @@ .. note:: + This section of the documentation is currently being written. pip developers welcome your help to complete this documentation. If you're interested in helping out, please let us know in the `tracking issue`_. diff --git a/docs/html/development/ci.rst b/docs/html/development/ci.rst index a953d046b..a0e8bd72f 100644 --- a/docs/html/development/ci.rst +++ b/docs/html/development/ci.rst @@ -1,4 +1,5 @@ .. note:: + This section of the documentation is currently being written. pip developers welcome your help to complete this documentation. If you're interested in helping out, please let us know in the `tracking issue`_. diff --git a/docs/html/development/issue-triage.rst b/docs/html/development/issue-triage.rst index d98fc67b6..edb86e7ee 100644 --- a/docs/html/development/issue-triage.rst +++ b/docs/html/development/issue-triage.rst @@ -1,4 +1,5 @@ .. note:: + This section of the documentation is currently being written. pip developers welcome your help to complete this documentation. If you're interested in helping out, please let us know in the diff --git a/docs/html/reference/pip_debug.rst b/docs/html/reference/pip_debug.rst index b89e531dd..da147bcf2 100644 --- a/docs/html/reference/pip_debug.rst +++ b/docs/html/reference/pip_debug.rst @@ -14,6 +14,7 @@ Usage .. warning:: + This command is only meant for debugging. Its options and outputs are provisional and may change without notice. diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index 92a74c953..9aa2cab68 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -74,6 +74,7 @@ Installation Order ------------------ .. note:: + This section is only about installation order of runtime dependencies, and does not apply to build dependencies (those are specified using PEP 518). @@ -676,6 +677,7 @@ Hash-checking mode also works with :ref:`pip download` and :ref:`pip wheel`. A ` is available in the User Guide. .. warning:: + Beware of the ``setup_requires`` keyword arg in :file:`setup.py`. The (rare) packages that use it will cause those dependencies to be downloaded by setuptools directly, skipping pip's hash-checking. If you need to use @@ -683,6 +685,7 @@ Hash-checking mode also works with :ref:`pip download` and :ref:`pip wheel`. A setup_requires`. .. warning:: + Be careful not to nullify all your security work when you install your actual project by using setuptools directly: for example, by calling ``python setup.py install``, ``python setup.py develop``, or diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 4ebccd5dd..603a57345 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -753,6 +753,7 @@ Hash-checking mode can be used along with this method to ensure that future archives are built with identical packages. .. warning:: + Finally, beware of the ``setup_requires`` keyword arg in :file:`setup.py`. The (rare) packages that use it will cause those dependencies to be downloaded by setuptools directly, skipping pip's protections. If you need