"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
- "sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
]
('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),
}
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
------------
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*