This file describes the documentation style used in all documentation found in
Open vSwitch. Documentation includes any documents found in Documentation
along with any README, MAINTAINERS, or generally rst suffixed
documents found in the project tree.

Note

This guide only applies to documentation for Open vSwitch v2.7. or greater.
Previous versions of Open vSwitch used a combination of Markdown and raw
plain text, and guidelines for these are not detailed here.

reStructuredText (rST) is the syntax, while Sphinx is a documentation
generator. Sphinx introduces a number of extensions to rST, like the :ref:
role, which can and should be used in documentation, but these will not work
correctly on GitHub. As such, these extensions should not be used in any
documentation in the root level, such as the README.