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

Ben Pfaff blp at ovn.org
Tue Oct 18 19:36:32 UTC 2016


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 <stephen at that.guru>

...

> +- Use reStructuredText (reST) for all documentation.
> +
> +  Sphinx extensions can be used, but only for documentation in the
> +  ``Documentation`` folder.
> +
> +  .. note::
> +    Some legacy documents may exist in other formats. When time allows, these
> +    should be converted to reST.

I think that you may be drawing some distinction between "documentation"
and "manpages".  I don't think that manpages should be written in reST.



More information about the dev mailing list