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

2016-10-18 Thread Ben Pfaff
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 '

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

2016-10-18 Thread Stephen Fincane
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. ___

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

2016-10-18 Thread Ben Pfaff
On Sat, Oct 08, 2016 at 02:18:00PM +0100, Stephen Finucane wrote: > We have one for coding and could do with one for docs. > > Signed-off-by: Stephen Finucane ... > +- Use reStructuredText (reST) for all documentation. > + > + Sphinx extensions can be used, but only for documentation in the >

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

2016-10-18 Thread Russell Bryant
On Sat, Oct 8, 2016 at 9:18 AM, Stephen Finucane wrote: > We have one for coding and could do with one for docs. > > Signed-off-by: Stephen Finucane > --- > DocumentationStyle.rst | 274 ++ > +++ > 1 file changed, 274 insertions(+) > create mode 1006

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

2016-10-08 Thread Stephen Finucane
We have one for coding and could do with one for docs. Signed-off-by: Stephen Finucane --- DocumentationStyle.rst | 274 + 1 file changed, 274 insertions(+) create mode 100644 DocumentationStyle.rst diff --git a/DocumentationStyle.rst b/Documenta