sphinx-github-role

A github role for Sphinx.

Installation

To install, run

(.venv) $ pip install sphinx-github-role

Usage

Basic usage

MyST:

index.md

See {github}`astrojuanlu/sphinx-github-role#1`.

reStructuredText:

index.rst

See :github:`astrojuanlu/sphinx-github-role#1`.

Configuring a default organization and project

The extension accepts a configuration github_default_org_project that can be a tuple ("default_org", "default_project") to save some typing. For example, with this configuration:

conf.py

github_default_org_project = ("astrojuanlu", None)

you can type this:

index.md

See {github}`sphinx-github-role#1`.

and with this configuration:

conf.py

github_default_org_project = ("astrojuanlu", "sphinx-github-role")

you only need to type this:

index.md

See {github}`#1`.

Customizing link text

You can also customize the link text, by wrapping the target in angle brackets:

index.md

See {github}`this issue <#1>`.

Contribute

Feel free to open an issue to report problems or suggest new features!