On Jan 20, 2009, at 1:22 PM, Mateusz Biliński wrote: >> 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/ > > There was an idea, similar to that (named 'Continuous Documentation') > on SCons's GSoC 2008 ideas list [1] (not taken last year), about > keeping docs in sync on website and in code.
I do such anything all the time, in a simple way, on all of the evoque- based web sites I manage. That templating supports pulling in any pieces of content form source files in any format. Up to the doc writer to then declare which pieces should appear where and how, whether raw or evaluated, formatting etc. Just look over the multiple examples (and outputs) taken directly from unit test code, benchmarks etc, all over the documentation site for Evoque Templating at http://evoque.gizmojo.org/ Note that the docs there refer to the imminently upcoming 0.4 release -- but synchronization is managed simply by having a checkout of the desired revision of the target project checked out for use by the docs. I usually just keep both doc and source at head versions, as I find this is the simplest. Integrating additional more ambitious "process management" requirements such as code reviews could be interesting to consider. > I guess this proves there is a need for such project. > > [1] > http://scons.org/wiki/GSoC2008#head-248a948c4bd65d3f8066972ba732a29ab4761ddb > > -- > Mateusz Biliński --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
