Skip to content

Conversation

@shenxianpeng
Copy link
Contributor

@shenxianpeng shenxianpeng commented Jun 3, 2025

It could be helpful for users if the Changlog included links to the related issues or pull requests. This would make it easier to trace the context behind each change.


Here used sphinx_issues, and it also aligns with other pypa projects

https://github.com/pypa/build/blob/6653cd288a4445bdc1ad55968ad584e0eeebc5aa/docs/conf.py#L38

https://github.com/pypa/pip/blob/c6f1c7905eab73f6bbebb0a35db7beeb901c4c36/docs/html/conf.py#L35

@shenxianpeng shenxianpeng marked this pull request as draft June 3, 2025 08:02
@shenxianpeng shenxianpeng marked this pull request as ready for review June 3, 2025 08:21
@shenxianpeng shenxianpeng changed the title feat: add extlinks for issue and pull feat: use sphinx-issues for linking Jun 3, 2025
@takluyver takluyver merged commit 10093cd into pypa:main Jun 7, 2025
21 checks passed
@takluyver
Copy link
Member

Thanks!

@shenxianpeng shenxianpeng deleted the update-docs branch June 7, 2025 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants