sounds like this app will be like djangobook - neat.

On Feb 10, 1:55 am, mdipierro <mdipie...@cs.depaul.edu> wrote:
> I am taking this approach for now:
>
> 1) convert the book to markdown (including conversion of eps images to
> png and conversion of references)
> 2) real time markdown to html (using special markup for references)
> 3) ability to annotate the book sections with user comments
> 4) automatically link all keywords in code example with corresponding
> docstrings
> 5) everything will have versioning so periodically I can diff the book
> and the docstrings and generate a patch (this will not be fully
> automated because the patch will be for wiki syntax not latex but I
> can convert back).
>
> When done I will loose some money from book sales so I will start
> taking donations. ;-)
>
> *** If you want to help, help make the Sphinx documentation work!!!
> ***
>
> So we can replace epydoc with Sphinx.
>
> Massimo
>
> On Feb 9, 7:59 am, Anand Vaidya <anandvaidya...@gmail.com> wrote:
>
> > I have checked some other projects (django, tg, pylons, python.org
> > etc). My understanding is that,
>
> > => The core documentation must be maintained by core-devs who know the
> > code inside out, This doc is the ultimate reference and should be in
> > Restructured format text-files, in  a SVN/Hg repository.
>
> > RST to HTML conversion should be performed and published online. Users
> > should be able to submit comments (Django allows at the paragraph
> > level, pylons allows comments at the page level). These comments
> > should be reviewed the core-dev or core-doc team and the docs updated
> > frequently.
>
> > => User generated docs which are likely to contain errors ,
> > inaccuracies, tips, hints etc should be maintained in a separate wiki/
> > site such as moinmoin or a CMS such as Drupal or Joomla. Some
> > extremely useful tips etc can be pulled into the core-docs. Some can
> > be left in this state and maintained separately.
>
> > I am accumulating all my comments 
> > here:http://webtopy.org/community/w2py-doc-conundrum
>
> > I am willing to assist in a one time Latex or PDF to ReST  manual
> > conversion . A group of members on this list can form a taskforce and
> > splitup chapters and perform the conversion.
>
> > If one of the list members can come up with a budget and a deadline to
> > develop a kickass web2py wiki, we can come up with contributions /
> > funds. I am willing to put up USD 100

-- 
You received this message because you are subscribed to the Google Groups 
"web2py-users" group.
To post to this group, send email to web...@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.

Reply via email to