diff --git a/docs/html/index.md b/docs/html/index.md new file mode 100644 index 00000000000..351d8f79ff5 --- /dev/null +++ b/docs/html/index.md @@ -0,0 +1,48 @@ +--- +hide-toc: true +--- + +# pip + +pip is the [package installer for Python][recommended]. You can use it to +install packages from the [Python Package Index][pypi] and other indexes. + +```{toctree} +:hidden: + +quickstart +installing +user_guide +reference/index +``` + +```{toctree} +:caption: Project +:hidden: + +development/index +ux_research_design +news +Code of Conduct +GitHub +``` + +If you want to learn about how to use pip, check out the following resources: + +- [Quickstart](quickstart) +- [Python Packaging User Guide](https://packaging.python.org) + +If you find bugs, need help, or want to talk to the developers, use our mailing +lists or chat rooms: + +- [GitHub Issues][issue-tracker] +- [Discourse channel][packaging-discourse] +- [User IRC][irc-pypa] +- [Development IRC][irc-pypa-dev] + +[recommended]: https://packaging.python.org/guides/tool-recommendations/ +[pypi]: https://pypi.org/ +[issue-tracker]: https://github.com/pypa/pip/issues/ +[packaging-discourse]: https://discuss.python.org/c/packaging/14 +[irc-pypa]: https://webchat.freenode.net/#pypa +[irc-pypa-dev]: https://webchat.freenode.net/#pypa-dev diff --git a/docs/html/index.rst b/docs/html/index.rst deleted file mode 100644 index b92a23e020a..00000000000 --- a/docs/html/index.rst +++ /dev/null @@ -1,63 +0,0 @@ -================================== -pip - The Python Package Installer -================================== - -pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes. - -Please take a look at our documentation for how to install and use pip: - -.. toctree:: - :maxdepth: 1 - - quickstart - installing - user_guide - reference/index - development/index - ux_research_design - news - -.. warning:: - - In pip 20.3, we've `made a big improvement to the heart of pip`_; - :ref:`Resolver changes 2020`. We want your input, so `sign up for - our user experience research studies`_ to help us do it right. - -.. warning:: - - pip 21.0, in January 2021, removed Python 2 support, per pip's - :ref:`Python 2 Support` policy. Please migrate to Python 3. - -If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms: - -* `Issue tracking`_ -* `Discourse channel`_ -* `User IRC`_ - -If you want to get involved, head over to GitHub to get the source code, and feel free to jump on the developer mailing lists and chat rooms: - -* `GitHub page`_ -* `Development mailing list`_ -* `Development IRC`_ - - -Code of Conduct -=============== - -Everyone interacting in the pip project's codebases, issue trackers, chat -rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_. - -.. _package installer: https://packaging.python.org/guides/tool-recommendations/ -.. _Python Package Index: https://pypi.org -.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html -.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html -.. _Installation: https://pip.pypa.io/en/stable/installing.html -.. _Documentation: https://pip.pypa.io/en/stable/ -.. _Changelog: https://pip.pypa.io/en/stable/news.html -.. _GitHub page: https://github.com/pypa/pip -.. _Issue tracking: https://github.com/pypa/pip/issues -.. _Discourse channel: https://discuss.python.org/c/packaging -.. _Development mailing list: https://mail.python.org/mailman3/lists/distutils-sig.python.org/ -.. _User IRC: https://webchat.freenode.net/?channels=%23pypa -.. _Development IRC: https://webchat.freenode.net/?channels=%23pypa-dev -.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md