lib.roles.github

GitHub role for Docutils.

django_docutils.lib.roles.github.github_role(name, rawtext, text, lineno, inliner, options=None, content=None)[source]

Role for linking to GitHub repos and issues.

Return type:

RoleFnReturnValue

Examples

vim-airline:

:gh:`vim-airline`

vim-airline’s org:

:gh:`vim-airline's org <vim-airline>`

vim-airline/vim-airline:

:gh:`vim-airline/vim-airline`

vim-airline/vim-airline#125:

:gh:`vim-airline/vim-airline#125`

this example issue:

:gh:`this example issue <vim-airline/vim-airline#125>`