From 0147cd1e29a0786a6c0b55b5875b3d363c705bfd Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Sun, 21 Mar 2021 11:35:45 +0000 Subject: [PATCH 1/3] Move /reference/ to /cli/ --- docs/html/{reference => cli}/index.rst | 0 docs/html/{reference => cli}/pip.rst | 0 docs/html/{reference => cli}/pip_cache.rst | 0 docs/html/{reference => cli}/pip_check.rst | 0 docs/html/{reference => cli}/pip_config.rst | 0 docs/html/{reference => cli}/pip_debug.rst | 0 docs/html/{reference => cli}/pip_download.rst | 0 docs/html/{reference => cli}/pip_freeze.rst | 0 docs/html/{reference => cli}/pip_hash.rst | 0 docs/html/{reference => cli}/pip_install.rst | 0 docs/html/{reference => cli}/pip_list.rst | 0 docs/html/{reference => cli}/pip_search.rst | 0 docs/html/{reference => cli}/pip_show.rst | 0 docs/html/{reference => cli}/pip_uninstall.rst | 0 docs/html/{reference => cli}/pip_wheel.rst | 0 docs/html/index.md | 2 +- 16 files changed, 1 insertion(+), 1 deletion(-) rename docs/html/{reference => cli}/index.rst (100%) rename docs/html/{reference => cli}/pip.rst (100%) rename docs/html/{reference => cli}/pip_cache.rst (100%) rename docs/html/{reference => cli}/pip_check.rst (100%) rename docs/html/{reference => cli}/pip_config.rst (100%) rename docs/html/{reference => cli}/pip_debug.rst (100%) rename docs/html/{reference => cli}/pip_download.rst (100%) rename docs/html/{reference => cli}/pip_freeze.rst (100%) rename docs/html/{reference => cli}/pip_hash.rst (100%) rename docs/html/{reference => cli}/pip_install.rst (100%) rename docs/html/{reference => cli}/pip_list.rst (100%) rename docs/html/{reference => cli}/pip_search.rst (100%) rename docs/html/{reference => cli}/pip_show.rst (100%) rename docs/html/{reference => cli}/pip_uninstall.rst (100%) rename docs/html/{reference => cli}/pip_wheel.rst (100%) diff --git a/docs/html/reference/index.rst b/docs/html/cli/index.rst similarity index 100% rename from docs/html/reference/index.rst rename to docs/html/cli/index.rst diff --git a/docs/html/reference/pip.rst b/docs/html/cli/pip.rst similarity index 100% rename from docs/html/reference/pip.rst rename to docs/html/cli/pip.rst diff --git a/docs/html/reference/pip_cache.rst b/docs/html/cli/pip_cache.rst similarity index 100% rename from docs/html/reference/pip_cache.rst rename to docs/html/cli/pip_cache.rst diff --git a/docs/html/reference/pip_check.rst b/docs/html/cli/pip_check.rst similarity index 100% rename from docs/html/reference/pip_check.rst rename to docs/html/cli/pip_check.rst diff --git a/docs/html/reference/pip_config.rst b/docs/html/cli/pip_config.rst similarity index 100% rename from docs/html/reference/pip_config.rst rename to docs/html/cli/pip_config.rst diff --git a/docs/html/reference/pip_debug.rst b/docs/html/cli/pip_debug.rst similarity index 100% rename from docs/html/reference/pip_debug.rst rename to docs/html/cli/pip_debug.rst diff --git a/docs/html/reference/pip_download.rst b/docs/html/cli/pip_download.rst similarity index 100% rename from docs/html/reference/pip_download.rst rename to docs/html/cli/pip_download.rst diff --git a/docs/html/reference/pip_freeze.rst b/docs/html/cli/pip_freeze.rst similarity index 100% rename from docs/html/reference/pip_freeze.rst rename to docs/html/cli/pip_freeze.rst diff --git a/docs/html/reference/pip_hash.rst b/docs/html/cli/pip_hash.rst similarity index 100% rename from docs/html/reference/pip_hash.rst rename to docs/html/cli/pip_hash.rst diff --git a/docs/html/reference/pip_install.rst b/docs/html/cli/pip_install.rst similarity index 100% rename from docs/html/reference/pip_install.rst rename to docs/html/cli/pip_install.rst diff --git a/docs/html/reference/pip_list.rst b/docs/html/cli/pip_list.rst similarity index 100% rename from docs/html/reference/pip_list.rst rename to docs/html/cli/pip_list.rst diff --git a/docs/html/reference/pip_search.rst b/docs/html/cli/pip_search.rst similarity index 100% rename from docs/html/reference/pip_search.rst rename to docs/html/cli/pip_search.rst diff --git a/docs/html/reference/pip_show.rst b/docs/html/cli/pip_show.rst similarity index 100% rename from docs/html/reference/pip_show.rst rename to docs/html/cli/pip_show.rst diff --git a/docs/html/reference/pip_uninstall.rst b/docs/html/cli/pip_uninstall.rst similarity index 100% rename from docs/html/reference/pip_uninstall.rst rename to docs/html/cli/pip_uninstall.rst diff --git a/docs/html/reference/pip_wheel.rst b/docs/html/cli/pip_wheel.rst similarity index 100% rename from docs/html/reference/pip_wheel.rst rename to docs/html/cli/pip_wheel.rst diff --git a/docs/html/index.md b/docs/html/index.md index 351d8f79ff5..a84c2665d0e 100644 --- a/docs/html/index.md +++ b/docs/html/index.md @@ -13,7 +13,7 @@ install packages from the [Python Package Index][pypi] and other indexes. quickstart installing user_guide -reference/index +cli/index ``` ```{toctree} From b2c5e1078b76edd60cfd0214500ccee4ba89833c Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Sun, 21 Mar 2021 11:37:36 +0000 Subject: [PATCH 2/3] 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 From 3fe1954e10fb96834731a111cb98932635b8cfaa Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Fri, 2 Apr 2021 11:32:19 +0100 Subject: [PATCH 3/3] Add redirects from the old /reference/ pages --- docs/html/reference/index.rst | 11 +++++++++++ docs/html/reference/pip.rst | 11 +++++++++++ docs/html/reference/pip_cache.rst | 11 +++++++++++ docs/html/reference/pip_check.rst | 11 +++++++++++ docs/html/reference/pip_config.rst | 11 +++++++++++ docs/html/reference/pip_debug.rst | 11 +++++++++++ docs/html/reference/pip_download.rst | 11 +++++++++++ docs/html/reference/pip_freeze.rst | 11 +++++++++++ docs/html/reference/pip_hash.rst | 11 +++++++++++ docs/html/reference/pip_install.rst | 11 +++++++++++ docs/html/reference/pip_list.rst | 11 +++++++++++ docs/html/reference/pip_search.rst | 11 +++++++++++ docs/html/reference/pip_show.rst | 11 +++++++++++ docs/html/reference/pip_uninstall.rst | 11 +++++++++++ docs/html/reference/pip_wheel.rst | 11 +++++++++++ 15 files changed, 165 insertions(+) create mode 100644 docs/html/reference/index.rst create mode 100644 docs/html/reference/pip.rst create mode 100644 docs/html/reference/pip_cache.rst create mode 100644 docs/html/reference/pip_check.rst create mode 100644 docs/html/reference/pip_config.rst create mode 100644 docs/html/reference/pip_debug.rst create mode 100644 docs/html/reference/pip_download.rst create mode 100644 docs/html/reference/pip_freeze.rst create mode 100644 docs/html/reference/pip_hash.rst create mode 100644 docs/html/reference/pip_install.rst create mode 100644 docs/html/reference/pip_list.rst create mode 100644 docs/html/reference/pip_search.rst create mode 100644 docs/html/reference/pip_show.rst create mode 100644 docs/html/reference/pip_uninstall.rst create mode 100644 docs/html/reference/pip_wheel.rst diff --git a/docs/html/reference/index.rst b/docs/html/reference/index.rst new file mode 100644 index 00000000000..5e81105c9ad --- /dev/null +++ b/docs/html/reference/index.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../cli/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/index` diff --git a/docs/html/reference/pip.rst b/docs/html/reference/pip.rst new file mode 100644 index 00000000000..53b1c9e0d41 --- /dev/null +++ b/docs/html/reference/pip.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip` diff --git a/docs/html/reference/pip_cache.rst b/docs/html/reference/pip_cache.rst new file mode 100644 index 00000000000..a9cbd69dae5 --- /dev/null +++ b/docs/html/reference/pip_cache.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_cache/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_cache` diff --git a/docs/html/reference/pip_check.rst b/docs/html/reference/pip_check.rst new file mode 100644 index 00000000000..5bb7fc84fcb --- /dev/null +++ b/docs/html/reference/pip_check.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_check/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_check` diff --git a/docs/html/reference/pip_config.rst b/docs/html/reference/pip_config.rst new file mode 100644 index 00000000000..31a048a513a --- /dev/null +++ b/docs/html/reference/pip_config.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_config/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_config` diff --git a/docs/html/reference/pip_debug.rst b/docs/html/reference/pip_debug.rst new file mode 100644 index 00000000000..b0de682751f --- /dev/null +++ b/docs/html/reference/pip_debug.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_debug/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_debug` diff --git a/docs/html/reference/pip_download.rst b/docs/html/reference/pip_download.rst new file mode 100644 index 00000000000..d54a7bec554 --- /dev/null +++ b/docs/html/reference/pip_download.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_download/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_download` diff --git a/docs/html/reference/pip_freeze.rst b/docs/html/reference/pip_freeze.rst new file mode 100644 index 00000000000..1cf31d5d708 --- /dev/null +++ b/docs/html/reference/pip_freeze.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_freeze/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_freeze` diff --git a/docs/html/reference/pip_hash.rst b/docs/html/reference/pip_hash.rst new file mode 100644 index 00000000000..6112bec5fa3 --- /dev/null +++ b/docs/html/reference/pip_hash.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_hash/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_hash` diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst new file mode 100644 index 00000000000..580900cfb93 --- /dev/null +++ b/docs/html/reference/pip_install.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_install/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_install` diff --git a/docs/html/reference/pip_list.rst b/docs/html/reference/pip_list.rst new file mode 100644 index 00000000000..3768baf60d6 --- /dev/null +++ b/docs/html/reference/pip_list.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_list/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_list` diff --git a/docs/html/reference/pip_search.rst b/docs/html/reference/pip_search.rst new file mode 100644 index 00000000000..0a7532ee79d --- /dev/null +++ b/docs/html/reference/pip_search.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_search/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_search` diff --git a/docs/html/reference/pip_show.rst b/docs/html/reference/pip_show.rst new file mode 100644 index 00000000000..b2ce3c7d8c3 --- /dev/null +++ b/docs/html/reference/pip_show.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_show/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_show` diff --git a/docs/html/reference/pip_uninstall.rst b/docs/html/reference/pip_uninstall.rst new file mode 100644 index 00000000000..db84476c859 --- /dev/null +++ b/docs/html/reference/pip_uninstall.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_uninstall/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_uninstall` diff --git a/docs/html/reference/pip_wheel.rst b/docs/html/reference/pip_wheel.rst new file mode 100644 index 00000000000..06861f60763 --- /dev/null +++ b/docs/html/reference/pip_wheel.rst @@ -0,0 +1,11 @@ +:orphan: + +.. meta:: + + :http-equiv=refresh: 3; url=../../cli/pip_wheel/ + +This page has moved +=================== + +You should be redirected automatically in 3 seconds. If that didn't +work, here's a link: :doc:`../cli/pip_wheel`