Using in RST: Unknown interpreted text role "github".

[sappelhoff]

Hi there, having seen your recent tweet I wanted to give this package (thanks for developing it!) a shot at https://github.com/autoreject/autoreject/pull/251.

I did the following:

• pip-installed sphinx-github-role in my doc build job
• added the following to my conf.py: github_default_org_project = ("autoreject", "autoreject")
• used the following syntax in my changelog:

:github:`#225`

Yet, the rendered docs look broken.

And the build log gives me an error:

Using in RST: Unknown interpreted text role "github".

Can you see what's going wrong? Is that some user error of mine? Or something with sphinx-github-role?

[astrojuanlu]

Hey @sappelhoff , thanks for trying it out! I left a comment in the PR. I'll leave this issue open as a reminder to myself to clarify in the readme that one needs to add sphinx_github_role to extensions in the conf.py.

[sappelhoff]

Okay, sounds good - a little reminder certainly would have helped me. Thanks!