zephyr/boards/arm/ubx_bmd345eval_nrf52840
Gerard Marull-Paretas e81e92dbb9 boards: convert images to JPEG and reduce image size
The boards folder uses ~142.8 MB, being the largest in the repository.
This is due mostly to board images, which are in most cases not
optimized for web content. This patch tries to address this problem by
converting all pictures to JPEG (quality 75) and by adjusting its size
up to 750 px (the width of the documentation content). Images that
specified a fixed width in rst files are converted down to that value
instead.

With this patch, folder goes down to ~53.5 MB from 142.8 MB (-~63%).
Note that this patch introduces a new set of binary files to git
history, though (bad).

The process has been automated using this quickly crafted Python script:

```python
from pathlib import Path
import re
import subprocess

def process(doc, image, image_jpeg, size):
    subprocess.run(
        (
	     f"convert {image}"
	     "-background white -alpha remove -alpha off -quality 75"
	     f"-resize {size}\> {image_jpeg}"
	),
        shell=True,
        check=True,
        cwd=doc.parent,
    )
    if image != image_jpeg:
        (doc.parent / image).unlink()

for doc in Path(".").glob("boards/**/*.rst"):
    with open(doc) as f:
        content = ""
        image = None
        for line in f:
            m = re.match(r"^(\s*)\.\. (image|figure):: (.*)$", line)
            if m:
                if image:
                    process(doc, image, image_jpeg, size)

                image = Path(m.group(3))
                if image.suffix not in (".jpg", ".jpeg", ".png"):
                    content += line
                    image = None
                    continue

                image_jpeg = image.parent / (image.stem + ".jpg")
                size = 750
                content += (
                    f"{m.group(1)}.. {m.group(2)}:: {image_jpeg}\n"
                )
            elif image:
                m = re.match(r"\s*:height:\s*[0-9]+.*$", line)
                if m:
                    continue

                m = re.match(r"\s*:width:\s*([0-9]+).*$", line)
                if m:
                    size = min(int(m.group(1)), size)
                    continue

                content += line
                if line == "\n":
                    process(doc, image, image_jpeg, size)
                    image = None
            else:
                content += line

    with open(doc, "w") as f:
        f.write(content)
```

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-08-29 10:18:18 +02:00
..
doc boards: convert images to JPEG and reduce image size 2022-08-29 10:18:18 +02:00
CMakeLists.txt
Kconfig
Kconfig.board
Kconfig.defconfig
board.c boards: remove usage of DT_LABEL 2022-06-27 12:45:19 +02:00
board.cmake boards: nrf: Fix jlink invocation strings 2022-03-25 13:39:28 +01:00
pre_dt_board.cmake boards: nrf52: Suppress DTC warnings about duplicate unit-address 2022-04-02 15:14:38 +02:00
ubx_bmd345eval_nrf52840-pinctrl.dtsi
ubx_bmd345eval_nrf52840.dts boards: arm: nordic: Remove label property from devicetree 2022-08-10 20:20:36 +02:00
ubx_bmd345eval_nrf52840.yaml boards: remove unused tag from supported list 2022-08-10 11:57:34 +02:00
ubx_bmd345eval_nrf52840_defconfig