hosting/ynh-apps_tools
1
0
Fork 0
Code Activity

move the screenshots code part to only run it once, since it do not change with language

Browse source
This commit is contained in:
OniriCorpe 2024-03-13 03:22:39 +01:00
parent 12f5aebd63
commit 41415c26a0
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
readme_generator/make_readme.py
View file

@ -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,16 +91,6 @@ def generate_READMEs(app_path: Path):
else:
description = None
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))
disclaimer: Optional[str]
if (app_path / "doc" / f"DISCLAIMER{lang_suffix}.md").exists():
disclaimer = (app_path / "doc" / f"DISCLAIMER{lang_suffix}.md").read_text()