From: Ben Darnell <ben@bendarnell.com>
Date: Mon, 20 Feb 2017 19:55:31 +0000 (-0500)
Subject: docs: Remove direct tarball links and legacy install instructions
X-Git-Tag: v4.5.0~36^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0400845b00350bd39eca9001c181e0806fefe83d;p=thirdparty%2Ftornado.git

docs: Remove direct tarball links and legacy install instructions

The tarball links were broken for many months without anyone noticing,
so apparently they weren't getting used (and anyone using them would
miss alternate release artifacts like the binary wheels we publish for
windows). Replace the hacks used to generate the tarball links with a
link to pypi and remove legacy manual installation instructions.
---

diff --git a/docs/conf.py b/docs/conf.py
index 1aaee07e4..18a75ff5f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,7 +16,6 @@ extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
-    "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
     ]
@@ -79,19 +78,6 @@ latex_documents = [
     ('index', 'tornado.tex', 'Tornado Documentation', 'The Tornado Authors', 'manual', False),
     ]
 
-# HACK: sphinx has limited support for substitutions with the |version|
-# variable, but there doesn't appear to be any way to use this in a link
-# target.
-# http://stackoverflow.com/questions/1227037/substitutions-inside-links-in-rest-sphinx
-# The extlink extension can be used to do link substitutions, but it requires a
-# portion of the url to be literally contained in the document.  Therefore,
-# this link must be referenced as :current_tarball:`z`
-extlinks = {
-    'current_tarball': (
-        'https://pypi.org/packages/source/t/tornado/tornado-%s.tar.g%%s' % version,
-        'tornado-%s.tar.g' % version),
-    }
-
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3.5/', None),
     }
diff --git a/docs/index.rst b/docs/index.rst
index d7f435d40..d8291598e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,14 +20,12 @@ applications that require a long-lived connection to each user.
 Quick links
 -----------
 
-* |Download current version|: :current_tarball:`z` (:doc:`release notes <releases>`)
+* Current version: |version| (`download from PyPI <https://pypi.python.org/pypi/tornado>`_, :doc:`release notes <releases>`)
 * `Source (github) <https://github.com/tornadoweb/tornado>`_
 * Mailing lists: `discussion <http://groups.google.com/group/python-tornado>`_ and `announcements <http://groups.google.com/group/python-tornado-announce>`_
 * `Stack Overflow <http://stackoverflow.com/questions/tagged/tornado>`_
 * `Wiki <https://github.com/tornadoweb/tornado/wiki/Links>`_
 
-.. |Download current version| replace:: Download version |version|
-
 Hello, world
 ------------
 
@@ -57,27 +55,16 @@ that see this `simple chat room
 Installation
 ------------
 
-**Automatic installation**::
+::
 
     pip install tornado
 
 Tornado is listed in `PyPI <http://pypi.python.org/pypi/tornado>`_ and
-can be installed with ``pip`` or ``easy_install``.  Note that the
-source distribution includes demo applications that are not present
-when Tornado is installed in this way, so you may wish to download a
-copy of the source tarball as well.
-
-**Manual installation**: Download :current_tarball:`z`:
-
-.. parsed-literal::
-
-    tar xvzf tornado-|version|.tar.gz
-    cd tornado-|version|
-    python setup.py build
-    sudo python setup.py install
-
-The Tornado source code is `hosted on GitHub
-<https://github.com/tornadoweb/tornado>`_.
+can be installed with ``pip``. Note that the source distribution
+includes demo applications that are not present when Tornado is
+installed in this way, so you may wish to download a copy of the
+source tarball or clone the `git repository
+<https://github.com/tornadoweb/tornado>`_ as well.
 
 **Prerequisites**: Tornado 4.3 runs on Python 2.7, and 3.3+
 For Python 2, version 2.7.9 or newer is *strongly*