IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Simplify the Installation section

Browse Source
This commit is contained in:
Adam Turner 2022-06-02 23:38:25 +01:00
parent 7a7c811ed2
commit 54acdc613c
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -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 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_
.. _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/