diff options
| author | Ilya Maximets <i.maximets@samsung.com> | 2017-03-10 12:25:52 +0300 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2017-03-17 13:19:11 -0700 |
| commit | 23cb93ff917e2addfed497730a8e72f261e677ce (patch) | |
| tree | 53a2f4d58cfa7a8b115fba1158d858e97e17c9af /Documentation/internals | |
| parent | c1397138cedf61856a815b02b9af26f80431d32d (diff) | |
| download | openvswitch-23cb93ff917e2addfed497730a8e72f261e677ce.tar.gz | |
Documentation: Remove external dependence on pygments.
Current documentation uses syntax highlighting in 'sphinx'
via 'pygments' library. This leads to build failures on the
systems with old version of this library.
In fact that only 'windows.rst' uses highlighting it's a
very simple change. This helps us to avoid build issues
on different systems and allows to remove painful external
dependency.
Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
| -rw-r--r-- | Documentation/internals/contributing/documentation-style.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index ea41a07e6..99eec6952 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -115,9 +115,11 @@ Titles Code ~~~~ -- Use ``::``, the ``code`` role or the ``code-block:: <syntax>`` role to prefix - code. The ``code-block:: <syntax>`` format is preferred as this provides - syntax highlighting for non-Python languages, such as Bash or PowerShell. +- Use ``::`` to prefix code. + +- Don't use syntax highlighting such as ``.. highlight:: <syntax>`` or + ``code-block:: <syntax>`` because it depends on external ``pygments`` + library. - Prefix commands with ``$``. @@ -259,7 +261,7 @@ Figures and Other Media - All images should be in PNG format and compressed where possible. For PNG files, use OptiPNG and AdvanceCOMP's ``advpng``: - .. code-block:: shell + :: $ optipng -o7 -zm1-9 -i0 -strip all <path_to_png> $ advpng -z4 <path_to_png> |