Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change all moved headings to rubrics #10913

Merged
merged 1 commit into from
Jun 10, 2022
Merged

Change all moved headings to rubrics #10913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/html/cli/pip.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ when decision is needed.
*(a)bort*
Abort pip and return non-zero exit status.


Build System Interface
======================
.. _`2-build-system-interface`:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These start-with-a-number references are here to let the anchors generated by Sphinx be the same (#build-system-interface) while allowing various instances of a rubric with the same content have the same anchor tag.

We could do this with :name: as well, but this felt more explicit and more as something we'd want to remove in, like, 1-2 years.

.. rubric:: Build System Interface

This is now covered in :doc:`../reference/build-system/index`.

Expand Down
51 changes: 20 additions & 31 deletions docs/html/cli/pip_install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,19 +148,18 @@ profile:
3. For whatever reason, they don't or won't declare their build dependencies using
``setup_requires``.


Requirements File Format
------------------------
.. _`0-requirements-file-format`:
.. rubric:: Requirements File Format

This section has been moved to :doc:`../reference/requirements-file-format`.

Requirement Specifiers
----------------------
.. _`0-requirement-specifiers`:
.. rubric:: Requirement Specifiers

This section has been moved to :doc:`../reference/requirement-specifiers`.

Per-requirement Overrides
-------------------------
.. _`0-per-requirement-overrides`:
.. rubric:: Per-requirement Overrides

This is now covered in :doc:`../reference/requirements-file-format`.

Expand All @@ -183,11 +182,8 @@ that enables installation of pre-releases and development releases.

.. _pre-releases: https://www.python.org/dev/peps/pep-0440/#handling-of-pre-releases


.. _`VCS Support`:

VCS Support
-----------
.. _`0-vcs-support`:
.. rubric:: VCS Support

This is now covered in :doc:`../topics/vcs-support`.

Expand Down Expand Up @@ -224,45 +220,38 @@ store. The default bundled CA certificate store certificate store may be
overridden by using ``--cert`` option or by using ``PIP_CERT``,
``REQUESTS_CA_BUNDLE``, or ``CURL_CA_BUNDLE`` environment variables.


.. _`Caching`:

Caching
-------
.. _`0-caching`:
.. rubric:: Caching

This is now covered in :doc:`../topics/caching`.

.. _`Wheel cache`:

Wheel Cache
^^^^^^^^^^^
.. _`0-wheel-cache`:
.. rubric:: Wheel Cache

This is now covered in :doc:`../topics/caching`.

Hash checking mode
------------------
.. _`0-hash-checking-mode`:
.. rubric:: Hash checking mode

This is now covered in :doc:`../topics/secure-installs`.

Local Project Installs
----------------------
.. _`0-local-project-installs`:
.. rubric:: Local Project Installs

This is now covered in :doc:`../topics/local-project-installs`.

Editable installs
-----------------
.. _`0-editable-installs`:
.. rubric:: Editable installs

This is now covered in :doc:`../topics/local-project-installs`.

Build System Interface
----------------------
.. _`0-build-system-interface`:
.. rubric:: Build System Interface

This is now covered in :doc:`../reference/build-system/index`.


.. _`pip install Options`:


Options
=======

Expand Down
4 changes: 2 additions & 2 deletions docs/html/cli/pip_wheel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Description
.. pip-command-description:: wheel


Build System Interface
----------------------
.. _`1-build-system-interface`:
.. rubric:: Build System Interface

This is now covered in :doc:`../reference/build-system/index`.

Expand Down
6 changes: 6 additions & 0 deletions docs/html/topics/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
(configuration)=

# Configuration

pip allows a user to change its behaviour via 3 mechanisms:
Expand All @@ -9,6 +11,8 @@ pip allows a user to change its behaviour via 3 mechanisms:
This page explains how the configuration files and environment variables work,
and how they are related to pip's various command line options.

(config-file)=

## Configuration Files

Configuration files can change the default values for command line option.
Expand Down Expand Up @@ -84,6 +88,8 @@ a configuration file that's loaded first, and whose values are overridden by
the values set in the aforementioned files. Setting this to {any}`os.devnull`
disables the loading of _all_ configuration files.

(config-precedence)=

### Loading order

When multiple configuration files are found, pip combines them in the following
Expand Down
2 changes: 2 additions & 0 deletions docs/html/topics/dependency-resolution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,8 @@ with [pip-tools](https://github.com/jazzband/pip-tools/).
This means the "work" is done once during development process, and thus
will avoid performing dependency resolution during deployment.

(Fixing conflicting dependencies)=

## Dealing with dependency conflicts

This section provides practical suggestions to pip users who encounter
Expand Down
1 change: 1 addition & 0 deletions docs/html/topics/vcs-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(vcs support)=
# VCS Support

pip supports installing from various version control systems (VCS).
Expand Down
51 changes: 19 additions & 32 deletions docs/html/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,18 @@ For more information and examples, see the :ref:`pip install` reference.

.. _PyPI: https://pypi.org/


Basic Authentication Credentials
================================
.. _`0-basic-authentication-credentials`:
.. rubric:: Basic Authentication Credentials

This is now covered in :doc:`topics/authentication`.

netrc Support
-------------
.. _`0-netrc-support`:
.. rubric:: netrc Support

This is now covered in :doc:`topics/authentication`.

Keyring Support
---------------
.. _`0-keyring-support`:
.. rubric:: Keyring Support

This is now covered in :doc:`topics/authentication`.

Expand Down Expand Up @@ -451,34 +450,26 @@ packages.

For more information and examples, see the :ref:`pip search` reference.

.. _`Configuration`:


Configuration
=============
.. _`0-configuration`:
.. rubric:: Configuration

This is now covered in :doc:`topics/configuration`.

.. _config-file:

Config file
-----------
.. _`0-config-file`:
.. rubric:: Config file

This is now covered in :doc:`topics/configuration`.

Environment Variables
---------------------
.. _`0-environment-variables`:
.. rubric:: Environment Variables

This is now covered in :doc:`topics/configuration`.

.. _config-precedence:

Config Precedence
-----------------
.. _`0-config-precedence`:
.. rubric:: Config Precedence

This is now covered in :doc:`topics/configuration`.


Command Completion
==================

Expand Down Expand Up @@ -780,18 +771,14 @@ is the latest version:
[...]
Successfully installed SomePackage
.. _`Repeatability`:


Ensuring Repeatability
======================
.. _`0-repeatability`:
.. _`0-ensuring-repeatability`:
.. rubric:: Ensuring Repeatability

This is now covered in :doc:`../topics/repeatable-installs`.

.. _`Fixing conflicting dependencies`:

Fixing conflicting dependencies
===============================
.. _`0-fixing-conflicting-dependencies`:
.. rubric:: Fixing conflicting dependencies

This is now covered in :doc:`../topics/dependency-resolution`.

Expand Down