diff --git a/src/generate_repo_overview/_html_common.py b/src/generate_repo_overview/_html_common.py index a491475..85ce43b 100644 --- a/src/generate_repo_overview/_html_common.py +++ b/src/generate_repo_overview/_html_common.py @@ -38,6 +38,7 @@ ) DOCS_ICON = "📑" +DOCS_AS_CODE_MODULE = "score_docs_as_code" def docs_url(org_name: str, repo_name: str) -> str: @@ -48,6 +49,13 @@ def docs_url(org_name: str, repo_name: str) -> str: return f"https://{org_name}.github.io/{repo_name}" +def uses_docs_as_code(entry: RepoEntry) -> bool: + return any( + module_name == DOCS_AS_CODE_MODULE + for module_name, _ in entry.content.bazel_deps + ) + + _LANGUAGE_COLORS: dict[str, str] = { "Python": "#3572A5", @@ -91,11 +99,12 @@ def repo_name_cell(entry: RepoEntry, org_name: str, *, bazel_icon: bool = True) f' {GITHUB_ICON}' ) - cell += ( - f' {DOCS_ICON}' - ) + if uses_docs_as_code(entry): + cell += ( + f' {DOCS_ICON}' + ) if entry.description: cell += f' {e(entry.description)}' return cell diff --git a/src/generate_repo_overview/_html_detail.py b/src/generate_repo_overview/_html_detail.py index 598cd38..9b250e4 100644 --- a/src/generate_repo_overview/_html_detail.py +++ b/src/generate_repo_overview/_html_detail.py @@ -10,6 +10,7 @@ docs_url, e, language_badge, + uses_docs_as_code, version_badge, ) from .metrics_report import tracked_dep_label @@ -64,6 +65,13 @@ def _render_hero(entry: RepoEntry, org_name: str) -> str: desc = e(entry.description) if entry.description else "" docs_url_str = docs_url(org_name, entry.name) + docs_link = ( + f' {DOCS_ICON}' + if uses_docs_as_code(entry) + else "" + ) return ( "
\n" '