diff --git a/tools/readme_generator/make_readme.py b/tools/readme_generator/make_readme.py index e7164ad58f..07e5001145 100755 --- a/tools/readme_generator/make_readme.py +++ b/tools/readme_generator/make_readme.py @@ -51,6 +51,16 @@ def generate_READMEs(app_path: Path): env = Environment(loader=FileSystemLoader(Path(__file__).parent / "templates")) + screenshots: List[str] + screenshots = [] + if (app_path / "doc" / "screenshots").exists(): + # only pick files (no folder) on the root of 'screenshots' + for entry in os.scandir(os.path.join(app_path, "doc", "screenshots")): + if os.DirEntry.is_file(entry): + # ignore '.gitkeep' or any file whose name begins with a dot + if not entry.name.startswith("."): + screenshots.append(os.path.relpath(entry.path, app_path)) + # parse available README template and generate a list in the form of: # > [("en", ""), ("fr", "_fr"), ...] available_langs: List[Tuple[str, str]] = [("en", "")] @@ -81,14 +91,6 @@ def generate_READMEs(app_path: Path): else: description = None - screenshots: List[str] - if (app_path / "doc" / "screenshots").exists(): - screenshots = os.listdir(os.path.join(app_path, "doc", "screenshots")) - if ".gitkeep" in screenshots: - screenshots.remove(".gitkeep") - else: - screenshots = [] - disclaimer: Optional[str] if (app_path / "doc" / f"DISCLAIMER{lang_suffix}.md").exists(): disclaimer = (app_path / "doc" / f"DISCLAIMER{lang_suffix}.md").read_text() diff --git a/tools/readme_generator/templates/README.md.j2 b/tools/readme_generator/templates/README.md.j2 index 8f51a4185f..46f33e45eb 100644 --- a/tools/readme_generator/templates/README.md.j2 +++ b/tools/readme_generator/templates/README.md.j2 @@ -42,7 +42,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Screenshots {% for screenshot in screenshots -%} - ![Screenshot of {{manifest.name}}](./doc/screenshots/{{screenshot}}) + ![Screenshot of {{manifest.name}}](./{{screenshot}}) {% endfor %} {% endif -%} diff --git a/tools/readme_generator/templates/README_fr.md.j2 b/tools/readme_generator/templates/README_fr.md.j2 index b02a7b86ab..fba3e1bec2 100644 --- a/tools/readme_generator/templates/README_fr.md.j2 +++ b/tools/readme_generator/templates/README_fr.md.j2 @@ -28,7 +28,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Captures d’écran {% for screenshot in screenshots -%} - ![Capture d’écran de {{manifest.name}}](./doc/screenshots/{{screenshot}}) + ![Capture d’écran de {{manifest.name}}](./{{screenshot}}) {% endfor %} {% endif -%}