Thanks for the discussion.
> What I can see from the short time I am following this project I get the
> impression that:
> * a lot of useful tips get burried in the mailing list
>
>
> Search - if you think it is generally useful, add to wiki!
> Rarely... people usually post again to remind;
If that is allowed I am fine with this. Some list really dislike this...
> * the documentation in the manual is good for learning but getting
> outdated.
>
>
> True enough; wiki is there, and sphinx docs should get started this
> summer. Massimo may also have plans for a revision of the book too.
Let me add this:
* there are many places to search for documenations
* google group
* new wiki
* PDFs on the doc page
* examples
* API doc
* why not add an custom search for all sources like:
http://www.rseek.org/ to the webpage?
>
> For sphinx-doc, best way to start contributing is in the wiki - please
> join in!
* many functions of the core are not documented with docstrings.
* would web2py community entertain a Sphinx effort?
* I have successfully documented my scripts with it!
I could help with my experiences. It's easy. I was using the numpy doc
standards
(http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard)
* may you please use SEO URLs in the wiki?
BTW, I see that the wiki supports rst formatted text.
I have some questions on this:
* will the functionality be added to core?
http://bazaar.launchpad.net/~mdipierro/web2py-wiki/trunk/annotate/head%3A/models/rest.py
* why is this file in the models subdirectory?
* how do I parse the docstrings of a action with rst to document my
applications in view?
* I want to use this as
http://en.wikipedia.org/wiki/Colophon_(publishing)
to document once and use twice (in internet and external
documentation)
For further rst integration please see also discussions at Sphinx list:
* further rst integration look at
* http://tosh.pl/gminick/gsoc/sphinx/#Techniques
*
http://thread.gmane.org/gmane.comp.python.sphinx.devel/1943/focus=1947
Kind regards,
Timmie
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
