diff options
| author | Curtis Maloney <curtis@tinbrain.net> | 2015-09-24 20:39:32 +1000 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2015-10-24 14:57:21 -0400 |
| commit | 35440ceab72ea3c24f3faaea9765271c7dac78f7 (patch) | |
| tree | 8a97004dce31e1a22495030c675b5bd809a399fa /docs/internals | |
| parent | 3c7d2ee881b13c7fdd0aa90b0aba0430310786de (diff) | |
Optimized docs images and documented the process.
Diffstat (limited to 'docs/internals')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 15 |
1 files changed, 15 insertions, 0 deletions
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 ---------- |
