Function setup

docs/sphinxext/github.py:161–173

Install the plugin. :param app: Sphinx application context.

(app)

def setup(app):
    """Install the plugin.

    :param app: Sphinx application context.
    """
    info("Initializing GitHub plugin")
    app.add_role("ghissue", ghissue_role)
    app.add_role("ghpull", ghissue_role)
    app.add_role("ghuser", ghuser_role)
    app.add_role("ghcommit", ghcommit_role)
    app.add_config_value("github_project_url", None, "env")

    return {"parallel_read_safe": True, "parallel_write_safe": True}