Skip to content

Commit 347e724

Browse files
committed
Change all moved headings to rubrics
This ensures that they don't show up in the table of contents sidebar, which is part of the point of moving this content into dedicated pages.
1 parent e58a8a5 commit 347e724

File tree

7 files changed

+52
-68
lines changed

7 files changed

+52
-68
lines changed

docs/html/cli/pip.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,8 @@ when decision is needed.
7474
*(a)bort*
7575
Abort pip and return non-zero exit status.
7676

77-
78-
Build System Interface
79-
======================
77+
.. _`2-build-system-interface`:
78+
.. rubric:: Build System Interface
8079

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

docs/html/cli/pip_install.rst

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -148,19 +148,18 @@ profile:
148148
3. For whatever reason, they don't or won't declare their build dependencies using
149149
``setup_requires``.
150150

151-
152-
Requirements File Format
153-
------------------------
151+
.. _`0-requirements-file-format`:
152+
.. rubric:: Requirements File Format
154153

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

157-
Requirement Specifiers
158-
----------------------
156+
.. _`0-requirement-specifiers`:
157+
.. rubric:: Requirement Specifiers
159158

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

162-
Per-requirement Overrides
163-
-------------------------
161+
.. _`0-per-requirement-overrides`:
162+
.. rubric:: Per-requirement Overrides
164163

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

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

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

186-
187-
.. _`VCS Support`:
188-
189-
VCS Support
190-
-----------
185+
.. _`0-vcs-support`:
186+
.. rubric:: VCS Support
191187

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

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

227-
228-
.. _`Caching`:
229-
230-
Caching
231-
-------
223+
.. _`0-caching`:
224+
.. rubric:: Caching
232225

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

235-
.. _`Wheel cache`:
236-
237-
Wheel Cache
238-
^^^^^^^^^^^
228+
.. _`0-wheel-cache`:
229+
.. rubric:: Wheel Cache
239230

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

242-
Hash checking mode
243-
------------------
233+
.. _`0-hash-checking-mode`:
234+
.. rubric:: Hash checking mode
244235

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

247-
Local Project Installs
248-
----------------------
238+
.. _`0-local-project-installs`:
239+
.. rubric:: Local Project Installs
249240

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

252-
Editable installs
253-
-----------------
243+
.. _`0-editable-installs`:
244+
.. rubric:: Editable installs
254245

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

257-
Build System Interface
258-
----------------------
248+
.. _`0-build-system-interface`:
249+
.. rubric:: Build System Interface
259250

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

262-
263253
.. _`pip install Options`:
264254

265-
266255
Options
267256
=======
268257

docs/html/cli/pip_wheel.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Description
2525
.. pip-command-description:: wheel
2626

2727

28-
Build System Interface
29-
----------------------
28+
.. _`1-build-system-interface`:
29+
.. rubric:: Build System Interface
3030

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

docs/html/topics/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
(configuration)=
2+
13
# Configuration
24

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

14+
(config-file)=
15+
1216
## Configuration Files
1317

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

91+
(config-precedence)=
92+
8793
### Loading order
8894

8995
When multiple configuration files are found, pip combines them in the following

docs/html/topics/dependency-resolution.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,8 @@ with [pip-tools](https://github.com/jazzband/pip-tools/).
161161
This means the "work" is done once during development process, and thus
162162
will avoid performing dependency resolution during deployment.
163163

164+
(Fixing conflicting dependencies)=
165+
164166
## Dealing with dependency conflicts
165167

166168
This section provides practical suggestions to pip users who encounter

docs/html/topics/vcs-support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(vcs support)=
12
# VCS Support
23

34
pip supports installing from various version control systems (VCS).

docs/html/user_guide.rst

Lines changed: 19 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -59,19 +59,18 @@ For more information and examples, see the :ref:`pip install` reference.
5959

6060
.. _PyPI: https://pypi.org/
6161

62-
63-
Basic Authentication Credentials
64-
================================
62+
.. _`0-basic-authentication-credentials`:
63+
.. rubric:: Basic Authentication Credentials
6564

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

68-
netrc Support
69-
-------------
67+
.. _`0-netrc-support`:
68+
.. rubric:: netrc Support
7069

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

73-
Keyring Support
74-
---------------
72+
.. _`0-keyring-support`:
73+
.. rubric:: Keyring Support
7574

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

@@ -451,34 +450,26 @@ packages.
451450

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

454-
.. _`Configuration`:
455-
456-
457-
Configuration
458-
=============
453+
.. _`0-configuration`:
454+
.. rubric:: Configuration
459455

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

462-
.. _config-file:
463-
464-
Config file
465-
-----------
458+
.. _`0-config-file`:
459+
.. rubric:: Config file
466460

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

469-
Environment Variables
470-
---------------------
463+
.. _`0-environment-variables`:
464+
.. rubric:: Environment Variables
471465

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

474-
.. _config-precedence:
475-
476-
Config Precedence
477-
-----------------
468+
.. _`0-config-precedence`:
469+
.. rubric:: Config Precedence
478470

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

481-
482473
Command Completion
483474
==================
484475

@@ -780,18 +771,14 @@ is the latest version:
780771
[...]
781772
Successfully installed SomePackage
782773
783-
.. _`Repeatability`:
784-
785-
786-
Ensuring Repeatability
787-
======================
774+
.. _`0-repeatability`:
775+
.. _`0-ensuring-repeatability`:
776+
.. rubric:: Ensuring Repeatability
788777

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

791-
.. _`Fixing conflicting dependencies`:
792-
793-
Fixing conflicting dependencies
794-
===============================
780+
.. _`0-fixing-conflicting-dependencies`:
781+
.. rubric:: Fixing conflicting dependencies
795782

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

0 commit comments

Comments
 (0)