Loading docs/internals/contributing/writing-documentation.txt +15 −0 Original line number Diff line number Diff line Loading @@ -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 ---------- Loading docs/intro/_images/admin01.png −390 B (4.25 KiB) Loading image diff... docs/intro/_images/admin02.png −681 B (13.6 KiB) Loading image diff... docs/intro/_images/admin03t.png −433 B (10.6 KiB) Loading image diff... docs/intro/_images/admin04t.png −194 B (9.64 KiB) Loading image diff... Loading
docs/internals/contributing/writing-documentation.txt +15 −0 Original line number Diff line number Diff line Loading @@ -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 ---------- Loading
