Ticket #34 (new defect)

Opened 3 years ago

Last modified 4 months ago

Add downloadable docs

Reported by: anonymous Assigned to: jorge.vargas
Priority: highest Milestone: __unclassified__
Component: Documentation Version: 1.0b2
Severity: normal Keywords:
Cc:

Description

A tarball for downloading all relevant documentation for TurboGears would be highly appreciated. Not everybody are connected to the net at all times. :-)

Attachments

docbox.patch (3.7 kB) - added by Kaan on 07/03/06 02:44:11.
An offline document viewer for the Toolbox (offline docs should be in turbogears/docs/)
docbox.png (4.0 kB) - added by Kaan on 07/03/06 02:46:42.
Icon for new toolbox (from KDE, licensed under LGPL)
tggen.py (1.7 kB) - added by fredlin on 12/01/06 20:44:55.
a rough script to download all 1.0 docs on docwiki, before running the script, you needto create a folder named "1.0", and four subfolders "GettingStarted?", "RoughDocs?", "SQLAlchemy", "Wiki20" in it. The downloaded file is saved as html format, feel free to enhance the code.
tggen.zip (1.5 kB) - added by fredlin on 12/05/06 19:13:49.
The file is almost done, execute the file will download doc/css/pic and create relative directories, lack: replace links to proper link
src.zip (3.2 kB) - added by Puck on 02/11/07 00:44:17.
Two parted script to mirror the wiki. Recursive download of all relevant wiki pages, blocking dynamic links, doesn't span hosts, patches links. This works on my windows box and is not very polished.
get_tgdoc.py (3.4 kB) - added by fredlin on 03/25/08 01:23:30.
new tgdoc.py to work with sphinx

Change History

11/18/05 12:29:21 changed by SuperJared <jared.kuolt@gmail.com>

  • owner changed from anonymous to SuperJared.

11/23/05 12:11:08 changed by SuperJared <jared.kuolt@gmail.com>

  • summary changed from Comment on docs/index.html to Add downloadable docs.
  • milestone set to 0.9.

12/30/05 15:15:11 changed by sluggoster@gmail.com

This is also useful for people who want to print the docs all at once and read them later.

01/26/06 15:00:13 changed by Joost

Actually why not make the docs/ refferences part of the toolbox?

04/19/06 20:11:22 changed by godoy

+1 on adding docs/ to the toolbox. It might become an online help.

05/31/06 00:37:22 changed by jorge.vargas

  • owner changed from SuperJared to jorge.vargas.

adding it to the toolbox or as some docudo module?

for now you can do a checkout of them

svn co http://www.turbogears.org/svn/turbogears/trunk/newdocs/ docs 

then zip it :p

07/02/06 00:07:12 changed by Kaan

Actually, that svn checkout doesn't really work too well. The webpages are in kid templates, which mean most of the links look like: "${root}/docs/index.html" and so on. Also there aren't any links to javascript or css in the head of those documents.

In order to get something useful, you need to just either scrape the main website or copy the docs of the TG DVD if you ordered one.

07/03/06 02:44:11 changed by Kaan

  • attachment docbox.patch added.

An offline document viewer for the Toolbox (offline docs should be in turbogears/docs/)

07/03/06 02:46:42 changed by Kaan

  • attachment docbox.png added.

Icon for new toolbox (from KDE, licensed under LGPL)

07/03/06 17:30:01 changed by Kaan

I made a tarball of static docs if anyone wants it (~3megs is too big for attachment here):

http://www.evil-robots.net/docs.tar.gz

09/21/06 13:02:39 changed by khorn

  • milestone changed from 0.9 to 1.0.

milestone passed, assigning to 1.0

09/21/06 13:03:00 changed by khorn

  • milestone changed from 1.0 to 1.0b3.

make that 1.0b3

12/01/06 20:44:55 changed by fredlin

  • attachment tggen.py added.

a rough script to download all 1.0 docs on docwiki, before running the script, you needto create a folder named "1.0", and four subfolders "GettingStarted?", "RoughDocs?", "SQLAlchemy", "Wiki20" in it. The downloaded file is saved as html format, feel free to enhance the code.

12/04/06 23:40:22 changed by fredlin

  • priority changed from normal to highest.
  • version set to 1.0b2.

People working in a more remote location don't always have a good internet connection.

To have a local copy of the docs as some people work offline most of the time.

Will there be: - a html tarball - a pdf version of the doc - a moinmoin dump of the actual doc

12/05/06 19:13:49 changed by fredlin

  • attachment tggen.zip added.

The file is almost done, execute the file will download doc/css/pic and create relative directories, lack: replace links to proper link

01/11/07 14:52:13 changed by alberto

  • milestone changed from 1.0b3 to 1.1.

01/13/07 09:38:02 changed by fredlin

Christopher Arndt's version to download all TurboGears documentation pages from the wiki in ReST format http://paste.turbogears.org/paste/841

Also an incomplete version

02/11/07 00:44:17 changed by Puck

  • attachment src.zip added.

Two parted script to mirror the wiki. Recursive download of all relevant wiki pages, blocking dynamic links, doesn't span hosts, patches links. This works on my windows box and is not very polished.

03/28/07 12:41:59 changed by alberto

  • milestone changed from 1.1 to __unclassified__.

Batch moved into unclassified from 1.1 to properly track progress on the later

02/01/08 22:19:26 changed by khorn

Tested the files in src.zip above

It seems to work OK, but the tg-header.jpg image doesn't get downloaded, and there may be a few other foibles.

03/25/08 01:23:30 changed by fredlin

  • attachment get_tgdoc.py added.

new tgdoc.py to work with sphinx