#2017: [PATCH] Update TG2 Contributing and DownloadInstall Docs
---------------------------+------------------------------------------------
Reporter: dlatornell | Owner: Chris Arndt
Type: enhancement | Status: new
Priority: normal | Milestone: 1.9.7b1
Component: Documentation | Version: trunk
Severity: normal | Keywords:
---------------------------+------------------------------------------------
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`?
--
Ticket URL: <http://trac.turbogears.org/ticket/2017>
TurboGears <http://www.turbogears.org/>
TurboGears front-to-back web development
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google
Groups "TurboGears Tickets" group.
This group is read-only. No posting by normal members allowed.
To unsubscribe from this group, send email to
[EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/turbogears-tickets?hl=en?hl=en
-~----------~----~----~----~------~----~------~--~---
