Skip to content

Commit 35440ce

Browse files
funkybobtimgraham
authored andcommitted
Optimized docs images and documented the process.
1 parent 3c7d2ee commit 35440ce

21 files changed

+15
-0
lines changed

docs/internals/contributing/writing-documentation.txt

+15
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,21 @@ If a function, attribute, etc. is added, it's also okay to use a
256256
We can simply remove the ``.. versionadded:: A.B`` annotation without any
257257
indentation changes when the time comes.
258258

259+
Minimizing images
260+
-----------------
261+
262+
Optimize image compression where possible. For PNG files, use OptiPNG and
263+
AdvanceCOMP's ``advpng``:
264+
265+
.. code-block:: console
266+
267+
$ cd docs/
268+
$ optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path "./_build/*" -name "*.png"`
269+
$ advpng -z4 `find . -type f -not -path "./_build/*" -name "*.png"`
270+
271+
This is based on OptiPNG version 0.7.5. Older versions may complain about the
272+
``--strip all`` option being lossy.
273+
259274
An example
260275
----------
261276

docs/intro/_images/admin01.png

-390 Bytes
Loading

docs/intro/_images/admin02.png

-681 Bytes
Loading

docs/intro/_images/admin03t.png

-433 Bytes
Loading

docs/intro/_images/admin04t.png

-194 Bytes
Loading

docs/intro/_images/admin05t.png

-396 Bytes
Loading

docs/intro/_images/admin06t.png

-177 Bytes
Loading

docs/intro/_images/admin07.png

-227 Bytes
Loading

docs/intro/_images/admin08t.png

-119 Bytes
Loading

docs/intro/_images/admin09.png

-168 Bytes
Loading

docs/intro/_images/admin10t.png

-1.05 KB
Loading

docs/intro/_images/admin11t.png

-465 Bytes
Loading

docs/intro/_images/admin12t.png

-292 Bytes
Loading

docs/intro/_images/admin13t.png

-640 Bytes
Loading

docs/intro/_images/admin14t.png

-975 Bytes
Loading
Loading
Loading
-24.2 KB
Loading
-30 KB
Loading
-25 KB
Loading
-5.55 KB
Loading

0 commit comments

Comments
 (0)