Skip to content

fix: point the PyPI README links at GitHub - #71

Merged
yang-dong-yd merged 1 commit into
mainfrom
fix/pypi-readme-links
Oct 24, 2026
Merged

yang-dong-yd merged 1 commit into
mainfrom
fix/pypi-readme-links

Conversation

@yang-dong-yd

Copy link
Copy Markdown
Contributor

Summary

pyproject.toml uses README.md as the PyPI long description. PyPI publishes only that text, not the repository files, so the relative language-switcher and LICENSE links resolve under pypi.org and return 404. Point them at GitHub.

The package is not on PyPI yet, so this lands before the first published page exists.

Changes

  • Make the English / Chinese links in README.md absolute GitHub URLs.
  • Make the LICENSE link in README.md an absolute GitHub URL.

Testing

python3 -m unittest discover -s tests -t tests -v

Result: Ran 466 tests in 10.652s — OK.

Scanned README.md for repository-relative links: 0 remaining.

Issues

No linked issue.

PyPI publishes only the README text, not the repository files, so the
relative language-switcher and LICENSE links resolve under pypi.org and
return 404. Point them at GitHub.
@yang-dong-yd
yang-dong-yd merged commit 35e0bc8 into main Oct 24, 2026
1 check passed
@yang-dong-yd
yang-dong-yd deleted the fix/pypi-readme-links branch October 24, 2026 08:58
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.1.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@github-actions github-actions Bot added the released Shipped in a release label Oct 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released Shipped in a release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant