Merge pull request #13778 from ichard26/docs/groups

Re-expose package selection group options

Author: notatallshaw

docs/html/cli/pip_download.rst

@@ -61,6 +61,8 @@ Options
 
 .. pip-index-options:: download
 
+.. pip-package-selection-options:: download
+
 
 Examples
 ========

docs/html/cli/pip_index.rst

@@ -30,6 +30,9 @@ Options
 
 .. pip-command-options:: index
 
+.. pip-index-options:: index
+
+.. pip-package-selection-options:: index
 
 
 Examples

docs/html/cli/pip_install.rst

@@ -266,6 +266,7 @@ Options
 
 .. pip-index-options:: install
 
+.. pip-package-selection-options:: install
 
 .. _`pip install Examples`:
 

docs/html/cli/pip_list.rst

@@ -31,6 +31,8 @@ Options
 
 .. pip-index-options:: list
 
+.. pip-package-selection-options:: list
+
 
 Examples
 ========

docs/html/cli/pip_lock.rst

@@ -31,6 +31,8 @@ Options
 
 .. pip-index-options:: lock
 
+.. pip-package-selection-options:: lock
+
 
 Examples
 ========

docs/html/cli/pip_wheel.rst

@@ -46,6 +46,8 @@ Options
 
 .. pip-index-options:: wheel
 
+.. pip-package-selection-options:: wheel
+
 
 Examples
 ========

docs/pip_sphinxext.py

@@ -190,6 +190,17 @@ def process_options(self) -> None:
         )
 
 
+class PipPackageSelectionOptions(PipOptions):
+    required_arguments = 1
+
+    def process_options(self) -> None:
+        cmd_name = self.arguments[0]
+        self._format_options(
+            [o() for o in cmdoptions.package_selection_group["options"]],
+            cmd_name=cmd_name,
+        )
+
+
 class PipCommandOptions(PipOptions):
     required_arguments = 1
 
@@ -316,6 +327,7 @@ def setup(app: Sphinx) -> dict[str, bool | str]:
     app.add_directive("pip-command-options", PipCommandOptions)
     app.add_directive("pip-general-options", PipGeneralOptions)
     app.add_directive("pip-index-options", PipIndexOptions)
+    app.add_directive("pip-package-selection-options", PipPackageSelectionOptions)
     app.add_directive(
         "pip-requirements-file-options-ref-list", PipReqFileOptionsReference
     )

noxfile.py

@@ -129,6 +129,7 @@ def test(session: nox.Session) -> None:
 
 @nox.session
 def docs(session: nox.Session) -> None:
+    session.install("-e", ".")
     session.install("--group", "docs")
 
     def get_sphinx_build_command(kind: str) -> list[str]:
@@ -158,6 +159,7 @@ def get_sphinx_build_command(kind: str) -> list[str]:
 
 @nox.session(name="docs-live")
 def docs_live(session: nox.Session) -> None:
+    session.install("-e", ".")
     session.install("--group", "docs", "sphinx-autobuild")
 
     session.run(