On Mon, May 11, 2009 at 3:50 PM, Tim Michelsen <[email protected]>wrote: .......
> So with reference to my post [1], I present a modified > welcome application which has the following new > features: > 1) A Sphinx template that can be used to document the > application. I think this a very convenient feature. > Imagine webdeveloper A creates an application of a > client but is not available any more after a few > months. With such a documentation the new > developer B can quickly take over! I glanced at this; I will have to look later, but a few things come to mind: - web2py "standard" sphinx extensions should be part of the shinx installation, and checked (not copies in local;) - python based make: there is already waf and scons; google Chrome build uses scons; waf seems lightweight; this is a project by itself - for now seems like an extra distraction, and "shiny thing" - make is good enough this week / this month... get cygwin make, or nmake for now.... - my branch has updated make, build, and "examples" linking of documentation - it doesn't look like you've looked at that, so I guess I better stop looking at yours, and finish mine first.... I want to see welcome have link to manual (for users), and link to api (for developers / when admin is up)... that would be a useful pattern to setup. build issues just seem like a distraction right now to me... > > 2) An demonstration example for showing the docstrings > of an action on the frontend (i.e. in the view). I don't understand what this is.... > > 3) the database name has been changed: > databases/storage.db => databases/storage.sqlite ... reason? > > > All nice but I need some help or experienced developer: > 1) the way external modules are imported in web2py > makes it very difficult to use the sphinx extension > autodoc to autodocument the controller functions: > > autodoc can' import/find module controllers.default > it reported error: No module named > applications.welcome_modif.modules.docutils please check your spelling > and sys.path > > => this happens because Sphinx uses the sys.path of > the systems Python install + the paths added in > conf.py whereas web2py seems to set its own > definitions. To me, this seems too far down the road for now... For me, the pattern - the thinking I have - is as follows: - Online docs for users; - first users are web2py developers; first "application" is web2py framework; extend and generalize: - online docs for users; - provide standard way to develop, starting template to make it easy; - provide basic documentation standards, basic behaviors (e.g. basic, minimal topic outline to start with; standard ways to return to application, generate / link to pdf version, etc.) - online docs for developers; - follow standard web2py docstring basics; - more interesting for modules / plugins / contrib, etc. development .... User docs online... to me this is the first priority; that we do this for web2py app developers first just blurs the two, but that's ok, useful... ... I will digest more later... --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
