On Wed, Sep 30, 2009 at 7:22 AM, Minh Nguyen <[email protected]> wrote: > Hi Peter, > > On Wed, Sep 30, 2009 at 7:59 PM, Peter Alexander <[email protected]> wrote: > > <SNIP> > >> Hi Minh, >> >> If you're interested and have the time.. great! You can certainly help >> with transposing (or finding/writing a script) docs in other formats >> to reST/sphinx. > > I can certainly do that. For example, as a start I can integrate the > Cython tutorial at ticket #381 [1] into the main documentation > repository [2]. The next thing is for me to do the same for the SciPy > paper at ticket #380 [3], but I'm still waiting for the sources of > that paper. > > >> Or anything that needs to be done for that matter. > > I'll pull from the official Cython documentation repository [2] to my > working repository at bitbucket [4]. Whatever changes I make, I'll > push them to my personal repository. When things are ready, I'll > upload patches to the Cython trac. At the moment, I don't have an > account on the Cython trac server and have sent an email to Robert > Bradshaw to request an account. > > I think if we're going to be working on the Cython documentation, I > should inform you of what I'll be doing so that we don't step on each > other's toes. The above are my tasks for the next day or two. I'll > inform you of further developments as they happen. > > [1] http://trac.cython.org/cython_trac/ticket/381 > > [2] http://hg.cython.org/cython-docs/ > > [3] http://trac.cython.org/cython_trac/ticket/380 > > [4] http://bitbucket.org/mvngu/cython-docs/ > > -- > Regards > Minh Van Nguyen > _______________________________________________ > Cython-dev mailing list > [email protected] > http://codespeak.net/mailman/listinfo/cython-dev >
That sounds like a plan. I think what we can do is just like you suggest then we can consider better integration where avoidance of overlap and better flow is the consideration. Overall, I think that the workflow that is presented on docs.cython.org should be reconsidered and therefore reorganized. Its not enough to provide abundance of info, but how well its consumed by the reader thats pertinent, imho. For instance I'm appreciative of less verbosity and more example snippets. More cross references and less paragraphs. Mind you this is not in regard to a tutorial per se, but more in concept of concise reference docs. But I defer... You know what is cool is the way that the 'cython -a' html report has folding. I think thats a dynamite way to do reference documentation. If you need more detail you unfold the section... Thats just dreamin' because I love outlines, but is not practical for us right now though... or is it ;-) _______________________________________________ Cython-dev mailing list [email protected] http://codespeak.net/mailman/listinfo/cython-dev
