Since I like the idea of having a php.net like documentation
application I took some time and created a basic application that may
kick-start the development of a web2py app that is just that.
So far only few features are implemented and this is rather a proof of
concept than the real thing.
I will be in holidays for the next 2 weeks so I thought I will share
what I have for now in case somebody wants to really start developing
the whole thing. If somebody is interested she/he could set up a
project on sf/bitbucket/... and recruit developers ...
If you cannot spend time helping to develop then just enjoy another
web2py powerd app and steal the best ideas for your project :P

Download:  http://jaguar.biologie.hu-berlin.de/~fkrause/web2py.app.doc2py.w2p
Screenshot: http://jaguar.biologie.hu-berlin.de/~fkrause/screenshot_doc2py.png


Some milestones that could/should be achieved (in no particular order)

User Management
 - i created a user management plugin that could be added
Module Management
 - manage modules that should be documented
 - make modules available in dropdown list (so far this is hard coded)
Translations
 - make everything translatable
Comments
 - enable users to comment each function
 - use plugin_wiki from cube2py for that (so users can add python code
that is displayed nicely)
Tagging
 - I created a tagging plugin that could be added
Enhance Display of documentation
 - show the source code a function/class
 - show function header without def (reuse logic from the arguments
section)
 - parse epydoc of documentation strings and add info to Arguments
section
Example Section
 - add an examples section
 - pull examples from docstring (e.g. from gluon docs example::)
Search
 - live serach for object names in tree
 - full text search (needs some index over all text to be build up,
maybe there is a py module for that already)
php.net Features
 - copy all nice features from php.net doc and make them look nice
(not purple on purple :P)

Reply via email to