CSS Styling for Linkcode Links

sphinx_github_style.add_linkcode_class.add_linkcode_node_class(app, doctree, docname)View on GitHub

View Source Code

def add_linkcode_node_class(app: Sphinx, doctree: Node, docname: str) -> None:
    """Changes every :class:`~.Node` added by :mod:`sphinx.ext.linkcode` to use the ``"linkcode-link"`` class

    This creates separation from the nodes added by :mod:`sphinx.ext.viewcode`, allowing
    for different link text and CSS styling

    Sets the link text to ``linkcode_link_text``, or ``"View on GitHub"`` if not provided
    """
    env = app.builder.env
    link_text = getattr(env.config, 'linkcode_link_text')

    for node in list(doctree.findall(nodes.inline)):
        if 'viewcode-link' in node['classes']:
            if node.parent.get('internal', None) is False:
                node['classes'] = ['linkcode-link']
                node.children = [Text(_(f'{link_text}'))]

Changes every Node added by sphinx.ext.linkcode to use the "linkcode-link" class

This creates separation from the nodes added by sphinx.ext.viewcode, allowing for different link text and CSS styling

Sets the link text to linkcode_link_text, or "View on GitHub" if not provided

The github_style.css StyleSheet

Links are styled as follows:

/* Change custom linkcode ("View on GitHub") to match viewcode ("[source]") */
.linkcode-link {
    color: #00e;
    font-size: 80%;
    margin-left: 10px;
}
/* Add a GitHub Icon to Linkcode Links */
.linkcode-link::after {
    content: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" width="16" height="12" viewBox="0 0 24 22"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"/></svg>');
    margin-left: 4px;
}

To make the viewcode-link links match with the linkcode-link links, add the following to your custom.css file:

/* Change viewcode "[source]" link position and colour to match linkcode */
.rst-content .viewcode-back, .rst-content .viewcode-link {
    color: #00e;
    padding-left: 12px;
}