small fix needed: === modified file 'web2py/doc/source/conf.py' --- web2py/doc/source/conf.py 2009-05-07 14:32:05 +0000 +++ web2py/doc/source/conf.py 2009-06-28 05:42:50 +0000 @@ -92,7 +92,9 @@ # The short X.Y version. version = version_str[1] # The full version, including alpha/beta/rc tags. -release = version_str[1] + ' ' + version_str[2] +release = version_str[1] +if len(version_str) > 2: + release += + ' ' + version_str[2]
# The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. On Sun, Jun 28, 2009 at 6:21 AM, mdipierro<[email protected]> wrote: > > I am not the expert on this or I will have done it already. ;-) > > Here is summary of a response to the same question I got from Tim > Michelsen, he is the expert. > > 1) we need to make sure that all docscring are conform to these specs: > http://sphinx.pocoo.org/rest.html > http://www.python.org/dev/peps/pep-0257/#specification > > 2) we need add some examples in the existing docstrings and make sure > all function parameters are documented. > > 3) Run sphinx which is under web2py/doc and make sure it generates the > documentation without breaking. > > I think if different people volunteer to get in charge of editing one > gluon/*.py file and we leave the testing and generation of the actual > docs to Tim we can get this one in less than one week. > > Massimo > > > > On Jun 27, 11:02 pm, Hans Donner <[email protected]> wrote: >> "At the same time we need to change the docstrings to make them reST/ >> Sphinx compliant. >> I would very much appreciate help with this part." >> >> If you can provide more info regarding this: what/how do you want to >> see the docstrings, and what makes the (non)complaint? >> >> On Sat, Jun 27, 2009 at 10:52 PM, mdipierro<[email protected]> wrote: >> >> >> I've been meaning to dig deeper into this; will do as well. Is there a >> >> thread on how the new DAL functions? >> >> > Not yet but I am hoping to post it within one week. This is my current >> > queue: >> > - finish review and include Hans and Alexey patches for tickets on GAE >> > (*) >> > - finish review and include Hans patch for Google Authentication (*) >> > - possibly merge Auth with CAS >> > - complete the DAL >> > - merge jpolite and kpax and T3 and create a new animal (a unicorn?) >> >> > At the same time we need to change the docstrings to make them reST/ >> > Sphinx compliant. >> > I would very much appreciate help with this part. >> >> > (*) You thought I had forgotten but I have not. > > > --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
fix-documentation-962.patch
Description: Binary data
