Skip to content

Commit 1ffe2bd

Browse files
committed
docs(_ext/package_reference): Add PyPI link to Package metadata section
why: Packages are now live on PyPI; metadata section should link there what: - Add PyPI bullet between GitHub source and Maturity lines - Update doctest to assert PyPI URL is present
1 parent cd3ce17 commit 1ffe2bd

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

docs/_ext/package_reference.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,6 +540,8 @@ def package_reference_markdown(package_name: str) -> str:
540540
--------
541541
>>> "Registered Surface" in package_reference_markdown("sphinx-fonts")
542542
True
543+
>>> "pypi.org/project/sphinx-fonts" in package_reference_markdown("sphinx-fonts")
544+
True
543545
>>> package_reference_markdown("nonexistent-package")
544546
''
545547
"""
@@ -574,11 +576,13 @@ def package_reference_markdown(package_name: str) -> str:
574576
lines.extend(["]", "```", ""])
575577

576578
if package["repository"]:
579+
pypi_url = f"https://pypi.org/project/{package_name}/"
577580
lines.extend(
578581
[
579582
"## Package metadata",
580583
"",
581584
f"- Source on GitHub: [{package_name}]({package['repository']}/tree/main/packages/{package_name})",
585+
f"- PyPI: [{package_name}]({pypi_url})",
582586
f"- Maturity: `{package['maturity']}`",
583587
"",
584588
]

0 commit comments

Comments
 (0)