diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-12-22 09:54:47 +0000 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-22 10:16:02 -0800 |
| commit | ae92b73c44fc27cd5add5dfcb0d8888d3360c2ed (patch) | |
| tree | 1a1443e068b099441ec4542bc2d9ff182fbc58d0 /Documentation/internals | |
| parent | 3476fd3b576666931794383e290efb3dbaeb6fae (diff) | |
| download | openvswitch-ae92b73c44fc27cd5add5dfcb0d8888d3360c2ed.tar.gz | |
doc: Minor formatting fixes to documentation-style
Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
| -rw-r--r-- | Documentation/internals/contributing/documentation-style.rst | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index b1b7e41e6..ef0e0e751 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -61,8 +61,9 @@ Many of the basic documentation guidelines match those of the - Limit lines at 79 characters. .. note:: - An exception to this rule is text within code-block elements that cannot be - wrapped and links within references. + + An exception to this rule is text within code-block elements that cannot + be wrapped and links within references. - Use spaces for indenation. @@ -86,8 +87,9 @@ File Names - Use lowercase filenames. .. note:: - An exception to this rule is any documents found in the root-level of the - project. + + An exception to this rule is any documents found in the root-level of the + project. Titles ~~~~~~ @@ -102,8 +104,8 @@ Titles .. note:: - Avoid using lower heading levels by rewriting and reorganizing the - information. + Avoid using lower heading levels by rewriting and reorganizing the + information. - Under- and overlines should be of the same length as that of the heading text. @@ -129,7 +131,7 @@ Admonitions .. note:: - This is a sample callout for some useful tip or trick. + This is a sample callout for some useful tip or trick. Example admonitions include: ``warning``, ``important``, ``note``, ``tip`` or ``seealso``. @@ -230,7 +232,8 @@ Cross-referencing Here is a link to the :doc:`/README.rst` .. note:: - This is a Sphinx extension. Do not use this in any top-level documents. + + This is a Sphinx extension. Do not use this in any top-level documents. - To cross-reference an arbitrary location in a doc, use the ``ref`` role.:: |