search

astrojuanlu / sphinx-github-role

A github role for Sphinx
https://sphinx-github-role.readthedocs.io
BSD 2-Clause "Simplified" License
5 stars 1 forks source link

Support linking directly to projects without an issue #17

Closed zml2008 closed 2 years ago

zml2008 commented 2 years ago

I'd like to use this role to be able to link directly to GitHub projects, rather than just to specific issues within the projects.

For example:

:github:`astrojuanlu/sphinx-github-role`

would link to this repository, without requiring an issue to be specified.

I'm documenting a project with different components across a variety of repositories, so a shorthand syntax for referencing specific repositories would be helpful.

astrojuanlu commented 2 years ago

Good idea @zml2008 ! Do you want to send a pull request for it?