Add Command Line Reference section to docs (#1934)

Co-authored-by: chrysle <fritzihab@posteo.de>

docs/cli/index.md

@@ -0,0 +1,10 @@
+# Command Line Reference
+
+This page provides a reference for the `pip-tools` command-line interface (CLI):
+
+```{toctree}
+:maxdepth: 1
+
+pip-compile
+pip-sync
+```

docs/cli/pip-compile.md

@@ -0,0 +1,5 @@
+# pip-compile
+
+```{program-output} pip-compile --help
+
+```

docs/cli/pip-sync.md

@@ -0,0 +1,5 @@
+# pip-sync
+
+```{program-output} pip-sync --help
+
+```

docs/conf.py

@@ -36,7 +36,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["myst_parser"]
+extensions = ["myst_parser", "sphinxcontrib.programoutput"]
 
 
 # -- Options for HTML output -------------------------------------------------

docs/index.md

@@ -9,6 +9,7 @@
 :maxdepth: 2
 :caption: Contents
 
+cli/index
 contributing
 changelog
 ```

docs/requirements.txt

@@ -2,3 +2,4 @@ furo >= 2021.7.5b38
 myst-parser >= 0.15.1
 setuptools-scm >= 6.0.1
 Sphinx >= 4.1.1
+sphinxcontrib-programoutput >= 0.17