[dev] syntax to use for documenting directives

Manlio Perillo manlio_perillo at libero.it
Sun Jan 6 21:58:36 MSK 2008

Cliff Wells ha scritto:
> On Sun, 2008-01-06 at 15:31 +0100, Manlio Perillo wrote:
> [...]
>> Lastly, the RestructuredText pages formatted by MoinMoin are not very
>> good.
>> http://wiki.codemongers.com/NginxNgxWSGIModule
> This isn't an easy fix at the wiki level: either we change every page on
> the wiki to match what the Restructured Text module expects to output,
> or we fix the Restructured Text module to output what has been being
> done on the wiki.  Neither of these sounds like a quick undertaking.
> Another option would be to generate Moin syntax from the Restructured
> Text *prior* to inserting it into the wiki.
>> Maybe the documentation format should be more "standardized".
> I think the informal "by example" way is fine.  We just need reviewers
> to make certain that updates follow existing conventions.  
> Also, if we want consistent documentation, we should probably stick to a
> single formatting engine rather than supporting a mashup of everyone's
> favorite.  

Right, this is the best solution.

But, is this possible using a wiki?

Or should we create a documentation repository, and then generate the 
html pages from that?

This documentation repository can be integrated with future 
documentation about nginx internals.

> Cliff

Manlio Perillo

More information about the nginx mailing list