On Wed, 2009-01-07 at 16:22 -0400, Jorge Vargas wrote: > > On Wed, Jan 7, 2009 at 12:08 AM, Ian Bicking <i...@colorstudy.com> wrote: > > > > Mike Orr wrote: > >> On Tue, Jan 6, 2009 at 6:26 AM, vArDo <mateusz.bilin...@gmail.com> wrote: > > Maybe a fun/useful project would be working on a system to make the > > documentation more useful or browsable? E.g., a comment system or a > > system to suggest patches. Maybe even with some workflow...? Maybe > > that scope is too large, and the problem too subtle. Though actually > > there's several clear models for this (e.g., Django docs) so that would > > provide a good guide. > > > > Writing a series of recipes (that can be tested automatically, probably > > with buildbot) might be a good addition? Figuring out how to write > > testable recipes is tricky, but a doable tricky. > > > This sounds like a very interesting project, I have been thinking of > something like that for some time. But as you said it quickly becomes > too large. If this gets narrowed down it could be a solid candidate. > Something like a code-review system meets wiki meets sphinx. It's so > useful that it could be used by other projects. In my initial search > for this someone point me out to http://docs.scipy.org/doc/
I think the way to do that is with doc test code in sphinx. The fact that you can hide code that still runs means you can make a recipe bit by bit and still be able to test the whole shebang by using the doctest builder. But I expect everyone already knows this... ;-) Iain --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "pylons-devel" group. To post to this group, send email to pylons-devel@googlegroups.com To unsubscribe from this group, send email to pylons-devel+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/pylons-devel?hl=en -~----------~----~----~----~------~----~------~--~---
