Hi Paul - Some of the existing documentation is copyrighted (e.g. the current book).
If you want to help w/ sphinx, suggest you get current version, and get familiar. I still have a few things to do with PyCon registration site, a couple of things to prepare for the conference. The idea behind Sphinx is that it should be book quality documentation available on the web, or in print (same content). That's the motivation behind using Sphinx. Because of that, I don't want to rush and put anyhing there. For example, the FAQ's will be the most useful, and only those that are verified current, correct and complete. That's the level I want for the Sphinx stuff. We'll put up a repository, and some test content shortly a few weeks after PyCon. Regards, Yarko Other pieces (e.g. AlterEgo/FAQ) we have and can put in a sphinx doc. On Tue, Mar 10, 2009 at 12:09 AM, Paul Eden <[email protected]> wrote: > I just had a thought. > > Why don't we put most/all of this existing official documentation (or make > links to it) into a sphinx site directly? > That way > - we have formal documentation right away in a great site under source > control. > - the wiki doesn't get cluttered with stuff that is already documented well > elsewhere. > > If anyone is already working on the sphinx site (Yarko?) and wants help, I > would like to help. > > Paul > > On Mon, Mar 9, 2009 at 9:00 PM, Paul Eden <[email protected]> wrote: > >> It looks to me like we can setup all of the following as links on the new >> wiki/sphinx site(s). >> >> - Official web2py manual on Lulu <http://www.lulu.com/content/4968879>, >> >> Amazon<http://www.amazon.com/Web2Py-Manual-Massimo-DiPierro/dp/0470432322>, >> Wiley<http://www.wiley.com/WileyCDA/WileyTitle/productCd-0470432322.html> >> - Free manual >> chapters<http://mdp.cti.depaul.edu/examples/static/web2py_manual_cut.pdf> >> - Cookbook >> tutorial<http://mdp.cti.depaul.edu/examples/static/cookbook.pdf> >> - Videos: small <http://www.vimeo.com/875433> | >> long<http://www.vimeo.com/428474>| >> shell <http://www.vimeo.com/879939> | on gae >> (short)<http://www.vimeo.com/933216>| on >> gae (long) <http://www.vimeo.com/932708> | >> tagging<http://www.vimeo.com/2720410>| >> cms <http://www.vimeo.com/1098656> | t3 <http://www.vimeo.com/2462041> >> - PyWorks 2009 >> Slides<http://mdp.cti.depaul.edu/examples/static/pyworks.pdf> >> - >> Cheatsheet<http://mdp.cti.depaul.edu/examples/static/web2py_cheatsheet.pdf> >> - Dependency >> Graph<http://mdp.cti.depaul.edu/examples/static/web2py_dependency_graph.pdf> >> - T2 Plugin <http://mdp.cti.depaul.edu/examples/static/t2.pdf> >> >> The following should be linked to on the wiki/sphinx sites(s), but should >> also get a *good dose of source code comments* since they are >> automatically generated from the source code (apparently) that will greatly >> enhance their benefit as references. >> >> - Interactive API >> Reference<http://mdp.cti.depaul.edu/examples/default/api> >> - epydocs (complete library >> reference)<http://mdp.cti.depaul.edu/examples/static/epydoc/index.html> >> >> I think the following could be ported to reST for the wiki/sphinx >> site(s). But I don't want to reinvent the wheel, so we don't have to port >> them. But if we don't, then I think we should make sure the documentation >> site (wiki/sphinx) site has some common look and feel with the main >> www.web2py.com site so users know they are on the official >> documentation. Then a good google custom search setup to search over >> everything would do wonders. >> >> - Interactive >> Examples<http://mdp.cti.depaul.edu/examples/default/examples> >> - Database Abstraction Layer >> Examples<http://mdp.cti.depaul.edu/examples/default/dal> >> - New Tools: Authentication, Authorization, and CRUD >> Examples<http://mdp.cti.depaul.edu/examples/default/tools> >> - FAQ <http://mdp.cti.depaul.edu/AlterEgo> >> - Help Migrating from >> - PHP <http://mdp.cti.depaul.edu/AlterEgo/default/show/106> >> - Java <http://mdp.cti.depaul.edu/AlterEgo/default/show/107> >> - Ruby on Rails<http://mdp.cti.depaul.edu/AlterEgo/default/show/103> >> - Django <http://mdp.cti.depaul.edu/AlterEgo/default/show/101> >> - TurboGears <http://mdp.cti.depaul.edu/AlterEgo/default/show/102> >> >> The following could have a page on the wiki/sphinx site(s) and also link >> to the online app. >> >> - Online Tools >> - Central Authentication Service <https://mdp.cti.depaul.edu/cas> >> - Layout Designer <http://mdp.cti.depaul.edu/layouts> >> - Interactive Model >> Builder<http://designer.bojanka.net/designer.html?keyword=web2pydesigner> >> >> For the appliances. Should we just link to the appliances app or should >> we change it somehow to allow for more documentation on the appliances in >> it? >> >> Once we get a go ahead on the place to document I would be happy to do any >> of the preceding. I don't have an over abundance of time, but I will have >> an hour or two a week (you might laugh but it is true ;-). With that said, >> I don't think this type of organization of existing documentation will, on >> the whole, take a huge amount of time. >> >> Paul Eden >> >> >> On Mon, Mar 9, 2009 at 8:19 PM, Paul Eden <[email protected]> wrote: >> >>> One thing I am not clear on yet. >>> >>> We talked about the possibility of a wiki and a sphinx site. >>> - Once we decide on those things, what are the suggested ways to >>> integrate all the existing >>> documentation<http://mdp.cti.depaul.edu/examples/default/docs>under the new >>> documentation system? >>> >>> Paul >>> >>> > > > -- > Best Regards, > > Paul Eden > > "...and a little looking out for the other guy too." > - Mr. Smith > > > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "web2py Web Framework" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/web2py?hl=en -~----------~----~----~----~------~----~------~--~---
