From bb1b2251ef515f14ef5572920e55e3403c3402ae Mon Sep 17 00:00:00 2001 From: Curtis Maloney Date: Thu, 24 Sep 2015 20:39:32 +1000 Subject: [1.9.x] Optimized docs images and documented the process. Backport of 35440ceab72ea3c24f3faaea9765271c7dac78f7 from master --- docs/internals/contributing/writing-documentation.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'docs/internals') diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 1159b94c38..b203d11e4a 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -256,6 +256,21 @@ If a function, attribute, etc. is added, it's also okay to use a We can simply remove the ``.. versionadded:: A.B`` annotation without any indentation changes when the time comes. +Minimizing images +----------------- + +Optimize image compression where possible. For PNG files, use OptiPNG and +AdvanceCOMP's ``advpng``: + +.. code-block:: console + + $ cd docs/ + $ optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path "./_build/*" -name "*.png"` + $ advpng -z4 `find . -type f -not -path "./_build/*" -name "*.png"` + +This is based on OptiPNG version 0.7.5. Older versions may complain about the +``--strip all`` option being lossy. + An example ---------- -- cgit v1.3