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 #2017 (closed enhancement: fixed)

Opened 11 years ago

Last modified 11 years ago

[PATCH] Update TG2 Contributing and DownloadInstall Docs

Reported by: dlatornell Owned by: mramm
Priority: normal Milestone:
Component: Documentation Version: trunk
Severity: normal Keywords:
Cc:

Description

As discussed on the trunk list a while ago ( http://groups.google.ca/group/turbogears-trunk/browse_thread/thread/47698bb9911a2da9) I've done an update on the Contributing and DownloadInstall pages to consolidate the instructions for source installation into one, cannonical location in docs/main/Contributing.rst.

Specifically, the attached patch:

  • updates Contributing.rst to my understanding of the current instructions for installing tg2 from source for developers
  • replaces the "install from source" section of DownloadInstall.rst with a link to the source installation section of Contributing.rst
  • replaces the content of INSTALL.txt with appropriate links to DownloadInstall.rst and Contributing.rst
  • deletes the paver-based installation instructions from README.txt

It also includes instructions for checking out and building the docs tree that reflect the recent move of docs out of tg2, and adds some comments about testing based on recent discussion on the trunk list.

One thing that I'm not clear on is the role of epydoc. I've left the text concerning its use for API docs in, but I wonder if it has been superceded by Sphinx:autodoc?

Change History

comment:1 Changed 11 years ago by dlatornell

Akismet rejected the patch as spam, so it's at  http://paste.turbogears.org/paste/10728

comment:2 Changed 11 years ago by Chris Arndt

  • Owner changed from Chris Arndt to mramm

comment:3 Changed 11 years ago by mramm

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

comment:4 Changed 11 years ago by anonymous

  • Milestone 1.9.7b1 deleted

Milestone 1.9.7b1 deleted

Note: See TracTickets for help on using tickets.