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

Reorganise links

Browse Source
This commit is contained in:
Adam Turner 2022-06-02 22:38:35 +01:00
parent 86a218ae8d
commit ec8c2e3c3e
1 changed files with 19 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.rst
View File

@ -7,7 +7,7 @@
:alt: Package on PyPI :alt: Package on PyPI
.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master .. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
:target: http://www.sphinx-doc.org/ :target: https://www.sphinx-doc.org/
:alt: Documentation Status :alt: Documentation Status
.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg .. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg
@ -45,14 +45,12 @@ Among its features are the following:
and inclusion of appropriately formatted docstrings and inclusion of appropriately formatted docstrings
* Setuptools integration * Setuptools integration
For more information, refer to the `the documentation`__. For more information, refer to the `the documentation`_.
.. __: http://www.sphinx-doc.org/
Installation Installation
============ ============
Sphinx is published on `PyPI`__ and can be installed from there:: Sphinx is published on `PyPI`_ and can be installed from there::
pip install -U sphinx pip install -U sphinx
@ -60,18 +58,13 @@ We also publish beta releases::
pip install -U --pre sphinx pip install -U --pre sphinx
If you wish to install `Sphinx` for development purposes, refer to `the If you wish to install Sphinx for development purposes, refer to
contributors guide`__. `the contributors guide`_.
__ https://pypi.org/project/Sphinx/
__ http://www.sphinx-doc.org/en/master/internals/contributing.html
Documentation Documentation
============= =============
Documentation is available from `sphinx-doc.org`__. Documentation is available from `sphinx-doc.org`_.
__ http://www.sphinx-doc.org/
Get in touch Get in touch
============ ============
@ -79,33 +72,18 @@ Get in touch
- Report bugs, suggest features or view the source code `on GitHub`_. - Report bugs, suggest features or view the source code `on GitHub`_.
- For less well defined questions or ideas, use the `mailing list`_. - For less well defined questions or ideas, use the `mailing list`_.
.. _on GitHub: https://github.com/sphinx-doc/sphinx Please adhere to our `code of conduct`_.
.. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
Please adhere to our `code of conduct`__.
__ http://www.sphinx-doc.org/en/master/code_of_conduct.html
Testing Testing
======= =======
Continuous testing is provided by `Travis`__ (for unit tests and style checks Continuous testing is provided by `GitHub Actions`_.
on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for For information on running tests locally, refer to `the contributors guide`_.
large processes like TeX compilation).
For information on running tests locally, refer to `the contributors guide`__.
__ https://travis-ci.org/sphinx-doc/sphinx
__ https://ci.appveyor.com/project/sphinxdoc/sphinx
__ https://circleci.com/gh/sphinx-doc/sphinx
__ http://www.sphinx-doc.org/en/master/internals/contributing.html
Contributing Contributing
============ ============
Refer to `the contributors guide`__. Refer to `the contributors guide`_.
__ http://www.sphinx-doc.org/en/master/internals/contributing.html
Release signatures Release signatures
================== ==================
@ -114,3 +92,12 @@ Releases are signed with following keys:
* `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_ * `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_ * `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_
.. _the documentation:
.. _sphinx-doc.org: https://www.sphinx-doc.org/
.. _code of conduct: https://www.sphinx-doc.org/en/master/code_of_conduct.html
.. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html
.. _on GitHub: https://github.com/sphinx-doc/sphinx
.. _GitHub Actions: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml
.. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
.. _PyPI: https://pypi.org/project/Sphinx/