ASCII images take up less space but are significantly less readable than
proper images.
Signed-off-by: Stephen Finucane <step...@that.guru>
---
.../internals/contributing/documentation-style.rst | 15 ++++++++++++---
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/Documentation/internals/contributing/documentation-style.rst
b/Documentation/internals/contributing/documentation-style.rst
index 3c04b86..b1b7e41 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
--
2.9.3
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
