github_link() — flask Function Reference

Architecture documentation for the github_link() function in conf.py from the flask codebase.

Function python ApplicationCore ExtensionRegistry

Entity Profile

ApplicationCore→ ExtensionRegistry→ github_link() — flask Function Reference

Dependency Diagram

graph TD
  1dfcc147_8ba4_5bb3_893f_90fb962fe225["github_link()"]
  d8f2a4e3_bbd9_0325_3d02_7eb0344595e7["conf.py"]
  1dfcc147_8ba4_5bb3_893f_90fb962fe225 -->|defined in| d8f2a4e3_bbd9_0325_3d02_7eb0344595e7
  style 1dfcc147_8ba4_5bb3_893f_90fb962fe225 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs/conf.py lines 72–97

def github_link(name, rawtext, text, lineno, inliner, options=None, content=None):
    app = inliner.document.settings.env.app
    release = app.config.release
    base_url = "https://github.com/pallets/flask/tree/"

    if text.endswith(">"):
        words, text = text[:-1].rsplit("<", 1)
        words = words.strip()
    else:
        words = None

    if packaging.version.parse(release).is_devrelease:
        url = f"{base_url}main/{text}"
    else:
        url = f"{base_url}{release}/{text}"

    if words is None:
        words = url

    from docutils.nodes import reference
    from docutils.parsers.rst.roles import set_classes

    options = options or {}
    set_classes(options)
    node = reference(rawtext, words, refuri=url, **options)
    return [node], []