From 2cf66036f9c9f33ed20a5fdb4ac35404b0bbda14 Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Mon, 24 Jul 2023 13:13:29 +0200 Subject: [PATCH 1/3] Add CLI Reference section to docs --- docs/cli-reference/index.md | 10 ++++++++++ docs/cli-reference/pip-compile.md | 5 +++++ docs/cli-reference/pip-sync.md | 5 +++++ docs/conf.py | 2 +- docs/index.md | 1 + docs/requirements.txt | 1 + 6 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/cli-reference/index.md create mode 100644 docs/cli-reference/pip-compile.md create mode 100644 docs/cli-reference/pip-sync.md diff --git a/docs/cli-reference/index.md b/docs/cli-reference/index.md new file mode 100644 index 000000000..d01254fbf --- /dev/null +++ b/docs/cli-reference/index.md @@ -0,0 +1,10 @@ +# CLI Reference + +This page provides a reference for the `pip-tools` command-line interface (CLI): + +```{toctree} +:maxdepth: 1 + +pip-compile +pip-sync +``` diff --git a/docs/cli-reference/pip-compile.md b/docs/cli-reference/pip-compile.md new file mode 100644 index 000000000..8e6188903 --- /dev/null +++ b/docs/cli-reference/pip-compile.md @@ -0,0 +1,5 @@ +# pip-compile + +```{program-output} pip-compile --help + +``` diff --git a/docs/cli-reference/pip-sync.md b/docs/cli-reference/pip-sync.md new file mode 100644 index 000000000..0ed5a05ad --- /dev/null +++ b/docs/cli-reference/pip-sync.md @@ -0,0 +1,5 @@ +# pip-sync + +```{program-output} pip-sync --help + +``` diff --git a/docs/conf.py b/docs/conf.py index 562ad5a9b..1f8491603 100644 --- a/docs/conf.py +++ b/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 ------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index 570ca947b..4fe6e795c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,7 @@ :maxdepth: 2 :caption: Contents +cli-reference/index contributing changelog ``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 225601578..87ab6b6de 100644 --- a/docs/requirements.txt +++ b/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 From 1efa7be2767952eebe2910fa6af6cb17f6db75e1 Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Mon, 24 Jul 2023 15:32:17 +0200 Subject: [PATCH 2/3] Update docs/cli-reference/index.md Co-authored-by: chrysle --- docs/cli-reference/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli-reference/index.md b/docs/cli-reference/index.md index d01254fbf..e3d9afb75 100644 --- a/docs/cli-reference/index.md +++ b/docs/cli-reference/index.md @@ -1,4 +1,4 @@ -# CLI Reference +# Command Line Reference This page provides a reference for the `pip-tools` command-line interface (CLI): From 058c13a08ae0e79ed0df5fc05a0ae888e7a77e58 Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Mon, 24 Jul 2023 15:35:25 +0200 Subject: [PATCH 3/3] Renam dir --- docs/{cli-reference => cli}/index.md | 0 docs/{cli-reference => cli}/pip-compile.md | 0 docs/{cli-reference => cli}/pip-sync.md | 0 docs/index.md | 2 +- 4 files changed, 1 insertion(+), 1 deletion(-) rename docs/{cli-reference => cli}/index.md (100%) rename docs/{cli-reference => cli}/pip-compile.md (100%) rename docs/{cli-reference => cli}/pip-sync.md (100%) diff --git a/docs/cli-reference/index.md b/docs/cli/index.md similarity index 100% rename from docs/cli-reference/index.md rename to docs/cli/index.md diff --git a/docs/cli-reference/pip-compile.md b/docs/cli/pip-compile.md similarity index 100% rename from docs/cli-reference/pip-compile.md rename to docs/cli/pip-compile.md diff --git a/docs/cli-reference/pip-sync.md b/docs/cli/pip-sync.md similarity index 100% rename from docs/cli-reference/pip-sync.md rename to docs/cli/pip-sync.md diff --git a/docs/index.md b/docs/index.md index 4fe6e795c..f9ab19706 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ :maxdepth: 2 :caption: Contents -cli-reference/index +cli/index contributing changelog ```