[ovs-dev] [PATCH 1/2] docs: Add documentation style guide

Ben Pfaff blp at ovn.org
Tue Oct 18 20:28:48 UTC 2016


On Tue, Oct 18, 2016 at 09:01:11PM +0100, Stephen Fincane wrote:
> On Tue, 2016-10-18 at 12:36 -0700, Ben Pfaff wrote:
> > > +  .. note::
> > > +    Some legacy documents may exist in other formats. When time
> > allows, these
> > > +    should be converted to reST.
> 
> Nope - just the remaining 'md' docs and anything without an extension.
> Manpages are different.

It might be worth defining the term "documentation" somewhere near the
top of DocumentationStyle.rst, since it seems to cover everything at
first glance.

Thanks,

Ben.



More information about the dev mailing list