> > An opinion: Ideally (to follow Fernando's request, which I agree with) > > a) docs is moved to a subdirectory of the normal cython repo > b) A script to build them is shipped with Cython (setup.py could do this > I suppose) > c) On each release, Robert runs a script on the server which generates > those html and docs in a subdirectory for the release, and updates the > current link to the docs. > b) already exists, there is a top level makefile that will generate anything people want. Just get the repo (make sure you have Sphinx installed, which is in PyPi) and run 'make html', or 'make latex', tell me if this doesn't work for anybody.
c) currently this approach would be far to slow, the docs need *a lot* of work to catch up to current Cython, as well as editing to make them feel less like a collection of disparate write ups (which in fact they are . . .). I am committed to this project, and will set aside a couple of hours a week to make this happen for the foreseeable future. As far as having links to historical versions, I think this is an important idea, but a bit premature for the current state of the docs, which are really of alpha quality (though better than anything else currently, in my opinion). To remind people what I have done: I combed over all the links that were given in the old Cython webpage for documentation, which was composed mostly of Greg Ewing's Pyrex manual and a bunch of Wiki cookbook like entries, FAQ, etc. I found this annoying so I just compiled everything together and Switched all mention of Pyrex to Cython. I have written a paragraph here and a paragraph there, but currently that is basically what we have. (So once again I think it is important to thank Greg for all his amazing work! I am going to add a section into the docs mentioning this history so that more credit is given than just being one of the authors.) Before we are committed to keeping historical versions online I would like at least to have reviewed each section, and made sure the prose and voice is consistent, and have much more of a tutorial to help beginning Cythoneers get up to speed. I think this will realistically take at least couple of months (given nobody else gets involved). In summary I think the current method of having a separate repo for the docs and a link to the generated docs being made from the main Cython page is the best, until we have a real release candidate ready. Once this happens we can think of including the docs into the main Cython repo, and having historical pointers. Until then I think the docs will be changing to rapidly and would make this a bit of a logistic hassle. So these are my opinions, but I, as always, am happy to go with what we all decide to do. Gabriel _______________________________________________ Cython-dev mailing list [email protected] http://codespeak.net/mailman/listinfo/cython-dev
