From eefd5412ce699749a50903deb32d834851bc6251 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Sun, 21 Mar 2021 11:37:36 +0000 Subject: [PATCH] Rewrite Commands section's landing page - reST -> MyST - Roughly group the commands, based on what they work on. --- docs/html/cli/index.md | 48 +++++++++++++++++++++++++++++++++++++++++ docs/html/cli/index.rst | 21 ------------------ 2 files changed, 48 insertions(+), 21 deletions(-) create mode 100644 docs/html/cli/index.md delete mode 100644 docs/html/cli/index.rst diff --git a/docs/html/cli/index.md b/docs/html/cli/index.md new file mode 100644 index 00000000000..f608da52113 --- /dev/null +++ b/docs/html/cli/index.md @@ -0,0 +1,48 @@ +# Commands + +The general options that apply to all the commands listed below can be +found [under the `pip` page in this section](pip). + +```{toctree} +:maxdepth: 1 +:hidden: + +pip +``` + +```{toctree} +:maxdepth: 1 +:caption: Environment Management and Introspection + +pip_install +pip_uninstall +pip_list +pip_freeze +pip_check +``` + +```{toctree} +:maxdepth: 1 +:caption: Handling Distribution Files + +pip_download +pip_wheel +pip_hash +``` + +```{toctree} +:maxdepth: 1 +:caption: Package Index information + +pip_show +pip_search +``` + +```{toctree} +:maxdepth: 1 +:caption: Managing pip itself + +pip_cache +pip_config +pip_debug +``` diff --git a/docs/html/cli/index.rst b/docs/html/cli/index.rst deleted file mode 100644 index d21b7a9801a..00000000000 --- a/docs/html/cli/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -=============== -Reference Guide -=============== - -.. toctree:: - :maxdepth: 2 - - pip - pip_install - pip_download - pip_uninstall - pip_freeze - pip_list - pip_show - pip_search - pip_cache - pip_check - pip_config - pip_wheel - pip_hash - pip_debug