diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-12-22 09:54:46 +0000 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-22 10:16:02 -0800 |
| commit | 3476fd3b576666931794383e290efb3dbaeb6fae (patch) | |
| tree | 7a38194750ff618213ebf82996cec34f356d4dd2 /Documentation/internals | |
| parent | 2eaf6a08559ac915da9e060ce0251ccfa9d97fcd (diff) | |
| download | openvswitch-3476fd3b576666931794383e290efb3dbaeb6fae.tar.gz | |
doc: Recommend compressed PNG images where possible
ASCII images take up less space but are significantly less readable than
proper images.
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 | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index 3c04b867f..b1b7e41e6 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -247,13 +247,22 @@ Cross-referencing Here is a cross-reference to :ref:`sample-crossref`. .. 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. Figures and Other Media ~~~~~~~~~~~~~~~~~~~~~~~ -- All images should be in ASCII format and included in code-blocks to preserve - formatting. +- 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> + +- Any ASCII text "images" should be included in code-blocks to preserve + formatting - Include other reStructuredText verbatim in a current document |