Hi -
Can you now also add one more source:
-- doc/build/html/index.html
This is the preliminary documentation built in sphinx, courtesy of Tim
Michelson which Massimo just added (Thanks Tim!)
Also - I ask that people take a good look at docstrings in the sources, and
- as you get answers to your questions on pieces, update the docstring (in
reStructuredText, of course).
Over time, this should set a pattern for a standard documentation docstring
we use. (Usage, and example would be good).
ALSO LOOK FOR:
- needed index entried ("see also" which link somewhere would be very
nice);
- any reST or other docstring coding bugs (bugs as far as sphinx is
concerned)
Currently, I get this error using Sphinx trunk:
reST markup error:
d:\Workspace\Web2Py\webfaction\devel\gluon\wsgiserver.py:docstring of
wsgiserver
.CherryPyWSGIServer:28: (SEVERE/4) Unexpected section title.
I'll look into this later, and post a patch if I can.
My point: please do the same: learn how reST works in docstrings, get
sphinx and docstrings installed on your machine and try building and
updating the docstrings, then provide patches.
Thanks Tim!
We're now starting to be on our way!
- Yarko
On Mon, May 4, 2009 at 9:49 AM, Wes James <[email protected]> wrote:
>
>
> On Sat, May 2, 2009 at 10:17 PM, Iceberg <[email protected]> wrote:
>
>>
>> In case you did not know yet, I would suggest an item zero:
>>
>> 0. web2py's built-in document center at
>> http://localhost:8000/examples/default/docs
>> And these are my favorite sections (The more important, the earlier it
>> appears):
>
>
> <snip>
>
> that's right! thx
>
>
>
> -wj
>
>
> >
>
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
