[zeromq-dev] Documentation Proposal

[Pieter Hintjens]

On Sat, Jul 10, 2010 at 7:38 AM, Martin Sustrik <sustrik at 250bpm.com> wrote:

> There are several possible advantages of this:

Agreed.

> As for the actual publishing of the docs, I've been thinking about it a
> bit and here are my thoughts...

Makes sense, but I'd include the generated docs with the source code
because it acts as a reference.  What I'd suggest is that the
generated docs be included in the source tree, and rebuilt regularly
(daily?) when there are changes, and the HTML uploaded to github for
public inspection.  This means if you grab the git you get the docs,
and each branch can have its own docs.

Downside: someone (Peter?) has to automate this and if the
auto-generation isn't done regularly, the docs become
counter-productive.

-Pieter