Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Ticket #34 (closed task: duplicate)

Opened 13 years ago

Last modified 8 years ago

Add downloadable docs

Reported by: anonymous Owned by: Chris Arndt
Priority: low Milestone: 1.1.x bugfix
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 Download (3.7 KB) - added by Kaan 13 years ago.
An offline document viewer for the Toolbox (offline docs should be in turbogears/docs/)
docbox.png Download (4.0 KB) - added by Kaan 13 years ago.
Icon for new toolbox (from KDE, licensed under LGPL)
tggen.py Download (1.7 KB) - added by fredlin 12 years ago.
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 Download (1.5 KB) - added by fredlin 12 years ago.
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 Download (3.2 KB) - added by Puck 12 years ago.
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 Download (3.4 KB) - added by fredlin 11 years ago.
new tgdoc.py to work with sphinx

Change History

comment:1 Changed 13 years ago by SuperJared <jared.kuolt@…>

  • Owner changed from anonymous to SuperJared

comment:2 Changed 13 years ago by SuperJared <jared.kuolt@…>

  • Summary changed from Comment on docs/index.html to Add downloadable docs
  • Milestone set to 0.9

comment:3 Changed 13 years ago by sluggoster@…

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

comment:4 Changed 13 years ago by Joost

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

comment:5 Changed 13 years ago by godoy

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

comment:6 Changed 13 years ago 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

comment:7 Changed 13 years ago 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.

Changed 13 years ago by Kaan

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

Changed 13 years ago by Kaan

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

comment:8 Changed 13 years ago 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

comment:9 Changed 13 years ago by khorn

  • Milestone changed from 0.9 to 1.0

milestone passed, assigning to 1.0

comment:10 Changed 13 years ago by khorn

  • Milestone changed from 1.0 to 1.0b3

make that 1.0b3

Changed 12 years ago by fredlin

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.

comment:11 Changed 12 years ago 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

Changed 12 years ago by fredlin

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

comment:12 Changed 12 years ago by alberto

  • Milestone changed from 1.0b3 to 1.1

comment:13 Changed 12 years ago 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

Changed 12 years ago by Puck

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.

comment:14 Changed 12 years ago by alberto

  • Milestone changed from 1.1 to __unclassified__

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

comment:15 Changed 11 years ago 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.

Changed 11 years ago by fredlin

new tgdoc.py to work with sphinx

comment:16 Changed 10 years ago by jorge.vargas

  • Milestone changed from __unclassified__ to 1.1 maintenance

I believe this is totally fixed for 2.x with Sphinx docs, what about the 1.1 branch?

comment:17 Changed 10 years ago by jorge.vargas

  • Milestone changed from 1.1 maintenance to 1.1

comment:18 Changed 10 years ago by jorge.vargas

  • Owner jorge.vargas deleted

comment:19 Changed 10 years ago by Chris Arndt

  • Owner set to Chris Arndt
  • Priority changed from highest to low

Setting this to low priority. I don't think this is worth the effort given the low interest in TG <= 2.0 these days.

comment:20 Changed 10 years ago by Chris Arndt

  • Type changed from defect to task

comment:21 Changed 10 years ago by Chris Arndt

  • Milestone changed from 1.1 to 1.1.x bugfix

Moving to 1.1.x bugfix release in preparation for 1.1rc1 release.

comment:22 Changed 8 years ago by chrisz

  • Status changed from new to closed
  • Resolution set to duplicate

moved to #2521

Note: See TracTickets for help on using tickets.