Hello, I think we are talking of the same ideas: > > My idea was to > > 1) remove all errors of the new docs (excluding API, wiki FAQ) > > ... I assume you mean from web2py-sphinx branch... Yes.
> > 2) then pull the latest devel > > 3) copy the docs over > > 4) commit and push to my repo > > 5) propose a merge with the web2py mainline. > I see - well, this would work for one-time; Yes. This merge could include only the API and the few accompaning docs I wrote. This will provide Massimo and contributers with the possibility to check their docstrings and update these accordingly. In a later effort, after the descion is made on what would happen with the wiki and the FAQ, these could be included. Regard my current state as a demostration. > The real solution is to have Massimo update the devel branch each time there > is an update, but obviously he would not want to do this for every docstring > change... Agree. But people need a possibility to see where their docstrings need to be improved. > I don't know who you have with push permissions, but I think we should work > out the docstring format we want to have, get agreement There is a clear standard: python docstring standard as in PEP257. The numpy standard extends this. See an example here: http://docs.scipy.org/doc/numpy/reference/generated/numpy.arctan.html If you fix the 360 somthing errors & warnings we currently have, we are well off. > Then the next sphinx steps can proceed, and people can add... I still don't > think we'll want the wiki as part of the docs in any "raw" format (it would > be redundant, and we would never keep up)... This has to be decided by the lead developers... I am too young here. > but one thing at a time! ;-) Good. CU. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "web2py Web Framework" group. To post to this group, send email to web2py@googlegroups.com To unsubscribe from this group, send email to web2py+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/web2py?hl=en -~----------~----~----~----~------~----~------~--~---
