search

sloria / sphinx-issues

A Sphinx extension for linking to your project's issue tracker
MIT License
54 stars 12 forks source link

Add support for linking to GitHub comments #91

Open sloria opened 5 years ago

webknjaz commented 9 months ago

Would the syntax be something like

:issue:`123#issuecomment-12345`

?

Or does it need to be a new RST role?

webknjaz commented 9 months ago

FWIW here's what I do in my projects typically —https://github.com/aio-libs/aiohttp/blob/a379e63/docs/conf.py#L158-L164 (pending replacement with this extension). I have a generic :gh: role as a stop gap for anything not covered by the specific ones like :pr: or :issue:.

sloria commented 9 months ago

I like the proposed syntax since it would support any hash fragment within an issue or PR 👍