From 54acdc613cac38f074087846a189d48d1700a8c6 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 2 Jun 2022 23:38:25 +0100 Subject: [PATCH] Simplify the Installation section --- README.rst | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 27ecb3ed8..7b9f0049b 100644 --- a/README.rst +++ b/README.rst @@ -54,17 +54,13 @@ For more information, refer to the `the documentation`_. Installation ============ -Sphinx is published on `PyPI`_ and can be installed from there:: +The following command installs Sphinx from the `Python Package Index`_. You will +need a working installation of Python and pip. + +.. code-block:: sh pip install -U sphinx -We also publish beta releases:: - - pip install -U --pre sphinx - -If you wish to install Sphinx for development purposes, refer to -`the contributors guide`_. - Contributing ============ @@ -79,7 +75,6 @@ Releases are signed with following keys: * `498D6B9E `_ * `5EBA0E07 `_ -.. _the documentation: -.. _sphinx-doc.org: https://www.sphinx-doc.org/ +.. _the documentation: https://www.sphinx-doc.org/ .. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html -.. _PyPI: https://pypi.org/project/Sphinx/ +.. _Python Package Index: https://pypi.org/project/Sphinx/