[3.6] Backport README.rst changes (GH-294)

(cherry picked from commit b3f1f59) (cherry picked from commit 1b3d88e) (cherry picked from commit c086685) (cherry picked from commit e32ec93) (cherry picked from commit 6329aea)
Dark417 · Feb 12, 2017 · Feb 12, 2017 · Feb 12, 2017 · Feb 12, 2017 · Feb 13, 2017
commit 814213bdf1b95a5d863311b61c671010291f1197
diff --git a/Doc/Makefile b/Doc/Makefile
@@ -153,7 +153,7 @@ dist:
 	cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub
 
 check:
-	$(PYTHON) tools/rstlint.py -i tools -i venv
+	$(PYTHON) tools/rstlint.py -i tools -i venv -i README.rst
 
 serve:
 	../Tools/scripts/serve.py build/html

diff --git a/Doc/README.txt → Doc/README.rst b/Doc/README.txt → Doc/README.rst
@@ -2,20 +2,21 @@ Python Documentation README
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This directory contains the reStructuredText (reST) sources to the Python
-documentation.  You don't need to build them yourself, prebuilt versions are
-available at <https://docs.python.org/dev/download.html>.
+documentation.  You don't need to build them yourself, `prebuilt versions are
+available <https://docs.python.org/dev/download.html>`_.
 
 Documentation on authoring Python documentation, including information about
-both style and markup, is available in the "Documenting Python" chapter of the
-developers guide <https://docs.python.org/devguide/documenting.html>.
+both style and markup, is available in the "`Documenting Python
+<https://docs.python.org/devguide/documenting.html>`_" chapter of the
+developers guide.
 
 
 Building the docs
 =================
 
-You need to have Sphinx <http://sphinx-doc.org/> installed; it is the toolset
+You need to have `Sphinx <http://sphinx-doc.org/>`_ installed; it is the toolset
 used to build the docs.  It is not included in this tree, but maintained
-separately and available from PyPI <https://pypi.python.org/pypi/Sphinx>.
+separately and `available from PyPI <https://pypi.python.org/pypi/Sphinx>`_.
 
 
 Using make
@@ -108,11 +109,11 @@ see the make targets above).
 Contributing
 ============
 
-Bugs in the content should be reported to the Python bug tracker at
-https://bugs.python.org.
+Bugs in the content should be reported to the 
+`Python bug tracker <https://bugs.python.org>`_.
 
-Bugs in the toolset should be reported in the Sphinx bug tracker at
-https://www.bitbucket.org/birkenfeld/sphinx/issues/.
+Bugs in the toolset should be reported in the 
+`Sphinx bug tracker <https://github.com/sphinx-doc/sphinx/issues>`_.
 
 You can also send a mail to the Python Documentation Team at docs@python.org,
 and we will process your request as soon as possible.

diff --git a/Doc/conf.py b/Doc/conf.py
@@ -37,7 +37,7 @@
 needs_sphinx = '1.2'
 
 # Ignore any .rst files in the venv/ directory.
-exclude_patterns = ['venv/*']
+exclude_patterns = ['venv/*', 'README.rst']
 
 
 # Options for HTML output

diff --git a/Doc/make.bat b/Doc/make.bat
@@ -74,7 +74,7 @@ echo.   Provided by this script:
 echo.      clean, check, serve, htmlview
 echo.
 echo.All arguments past the first one are passed through to sphinx-build as
-echo.filenames to build or are ignored.  See README.txt in this directory or
+echo.filenames to build or are ignored.  See README.rst in this directory or
 echo.the documentation for your version of Sphinx for more exhaustive lists
 echo.of available targets and descriptions of each.
 echo.

diff --git a/README.rst b/README.rst
@@ -15,6 +15,22 @@ reserved.
 
 See the end of this file for further copyright and license information.
 
+General Information
+-------------------
+
+- Website: https://www.python.org
+- Source code: https://github.com/python/cpython
+- Issue tracker: https://bugs.python.org
+- Documentation: https://docs.python.org
+- Developer's Guide: https://docs.python.org/devguide/
+
+Contributing to CPython
+-----------------------
+
+For more complete instructions on contributing to CPython development,
+see the `Developer Guide`_.
+
+.. _Developer Guide: https://docs.python.org/devguide/
 
 Using Python
 ------------
@@ -28,7 +44,7 @@ Installable Python kits, and information about using Python, are available at
 Build Instructions
 ------------------
 
-On Unix, Linux, BSD, OSX, and Cygwin::
+On Unix, Linux, BSD, macOS, and Cygwin::
 
     ./configure
     make
@@ -38,10 +54,10 @@ On Unix, Linux, BSD, OSX, and Cygwin::
 This will install Python as python3.
 
 You can pass many options to the configure script; run ``./configure --help``
-to find out more.  On OSX and Cygwin, the executable is called ``python.exe``;
+to find out more.  On macOS and Cygwin, the executable is called ``python.exe``;
 elsewhere it's just ``python``.
 
-On Mac OS X, if you have configured Python with ``--enable-framework``, you
+On macOS, if you have configured Python with ``--enable-framework``, you
 should use ``make frameworkinstall`` to do the installation.  Note that this
 installs the Python executable in a place that is not normally on your PATH,
 you may want to set up a symlink in ``/usr/local/bin``.
@@ -126,12 +142,8 @@ is downloadable in HTML, PDF, and reStructuredText formats; the latter version
 is primarily for documentation authors, translators, and people with special
 formatting requirements.
 
-If you would like to contribute to the development of Python, relevant
-documentation is available in the `Python Developer's Guide
-<https://docs.python.org/devguide/>`_.
-
-For information about building Python's documentation, refer to `Doc/README.txt
-<https://github.com/python/cpython/blob/3.6/Doc/README.txt>`_.
+For information about building Python's documentation, refer to `Doc/README.rst
+<https://github.com/python/cpython/blob/3.6/Doc/README.rst>`_.
 
 
 Converting From Python 2.x to 3.x