Documentation

101 views
Skip to first unread message

Matheus S.

unread,
Aug 7, 2012, 9:32:53 AM8/7/12
to python-...@googlegroups.com
Hello, i'm learning Tornado and i'm loving it!
But is strange that in the website don't have the option to Donwload the Documentation, which would help a lot.
So i'm writting this to inform that situation.

Thanks,
Matheus Sampaio 

Matthew Ferguson

unread,
Aug 7, 2012, 9:38:26 AM8/7/12
to python-...@googlegroups.com
You can build the documentation yourself, all of the necessary resources are in the GitHub repository.

Another option is to just use wget to get an offline-ready copy:

Matheus S.

unread,
Aug 7, 2012, 9:47:44 AM8/7/12
to python-...@googlegroups.com
Yes but this is troublesome and waste of time, is more simple to only add a pdf link with the documentation of tornado at the first page...

And let's be honest i think that the documentation need more informations, a lot of things WE miss there... 

The things i'm saying here isn't because i hate Tornado, is the contrary i love it, the people will enjoy more if is simple to find at they are searching...

Lorenzo Bolla

unread,
Aug 7, 2012, 10:30:21 AM8/7/12
to python-...@googlegroups.com
$> git clone https://github.com/facebook/tornado.git
$> cd tornado/website
$> make html
$> w3m sphinx/build/html/index.html

If you find errors/omissions in the docs, feel free to submit a pull request!

L.

aliane abdelouahab

unread,
Aug 7, 2012, 1:01:19 PM8/7/12
to Tornado Web Server
download Torando from Github and not from the website, you'll get the
documentation + examples.
then install Sphinx and just run make.
if you get problems, it's due to the mysql driver. i dont know if it
has been fixed, but personnaly, i've removed the mysql chapter and it
worked :D

aliane abdelouahab

unread,
Aug 7, 2012, 1:11:48 PM8/7/12
to Tornado Web Server
and forget something
dont download the documentation from website, because when u'll make a
search, you"ll get sent to tornado site, build your own documentation
to allow searching locally.

Andrew Grigorev

unread,
Aug 7, 2012, 1:19:08 PM8/7/12
to Ben Darnell, Tornado Mailing List
Hi.

IMO, this is a good idea. It should be easy to make a PDF file available
for download from website using rst2pdf or latex sphinx builders.
Ability to download documentation is a good point.

Ben, am I right, or there are problems, which I can't see? What hosting
tornadoweb.org is using?

07.08.2012 17:32, Matheus S. пишет:
--
Andrew

Ben Darnell

unread,
Aug 11, 2012, 3:27:09 PM8/11/12
to Andrew Grigorev, Tornado Mailing List
tornadoweb.org is currently hosted on app engine (source code in the
website directory of the git repo), although now that it's 99%
sphinx-generated HTML we may move off of app engine at some point.
There's a mirror at http://tornado.readthedocs.org, and while it's not
easily discoverable, they've been offering zipped html and epub
downloads at http://readthedocs.org/projects/tornado/downloads/

I've just turned on pdf generation as well. It's a little wonky (the
table of contents is empty on readthedocs, although it works when I
build a pdf locally), but it mostly works.

-Ben
Reply all
Reply to author
Forward
0 new messages