On Thu, May 7, 2009 at 2:41 PM, Tim Michelsen <[email protected]>wrote:
> > >> BTW, > >> Each app could have its own doc folder... > > > > could you elaborate? > 1) create a doc folder in the app folder We could make this part of standard template, part of welcome app (first gluon gocstrings!) > 2) cd doc > 3) $: sphinx-quickstart would already be there w/ template (as Tim says, below) > > 4) write some intraductory text > 5) include docstrings complying with web2py howto (to be written) > 6) create a document that uses autodoc to API document the controllers, > models. > 6) built the docs. We could even add to admin a "build docs" link - and check for presence of sphinx, docutils This would encourage all apps to have at least basic docs. Also, for apps for end users, we'd want to have / make build of docstrings separate from end user docs (so you could choose which to give to your end users as part of your app). We can also (eventually) get fancy and include an overview directory with links to the TOC, and short description of each app in a web2py installation... But this would be building on what we are starting w/ Tim's effort, and now w/ docstrings updates over the next week. - Yarko > > > There could be a example for the examples application. > And a template created when a new application is created in the admin. > If you want, you can also use admin to modify basic values of Sphinx > config.py. > > Can you see where I am looking at? > > Please remind me to post the front end auto-documenting app. I do not > have time today, but... > > Regards, > Timmie > > > > > --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
