Sphinx Github Integration and Github Dark Theme Pygments Style
Project description
GitHub source code links and syntax highlighting for Sphinx docs
About
sphinx-github-style is a Sphinx extension that makes your docs look like and link to GitHub
…
GitHub Source Code Links
Using sphinx.ext.linkcode, a View on GitHub link is added to the documentation of every class, method and function:
They link to and highlight the corresponding code block in your GitHub repo:
📝 Note |
---|
These links can be used with/instead of the links added by sphinx.ext.viewcode
|
Syntax Highlighting
sphinx-github-style also contains a Pygments style to highlight code in your documentation similar to GitHub:
Installation
To install using pip:
pip install sphinx-github-style
Configuration
Add the extension to your conf.py
extensions = [
"sphinx_github_style",
]
…
Configuration Variables
Add any of the following configuration variables to your conf.py
linkcode_blob
linkcode_blob: str = "head"
The blob to link to on GitHub - any of "head", "last_tag", or "{blob}"
head (default): links to the most recent commit hash; if this commit is tagged, uses the tag instead
last_tag: links to the most recently tagged commit; if no tags exist, uses head
blob: links to any blob you want, for example "master" or "v2.0.1"
…
linkcode_url
linkcode_url: str = f"https://github.com/{html_context['github_user']}/{html_context['github_repo']}/{html_context['github_version']}"
The link to your GitHub repository formatted as https://github.com/user/repo
If not provided, will attempt to create the link from the html_context dict
…
linkcode_link_text
linkcode_link_text: str = "View on GitHub"
The text to use for the linkcode link
…
linkcode_resolve
linkcode_resolve: types.FunctionType
A linkcode_resolve() function to use for resolving the link target
Uses default function from get_linkcode_resolve() if not specified (recommended)
Noteworthy Components
TDKStyle - Pygments Style for syntax highlighting similar to Github Pretty Lights Dark Theme
TDKMethLexor - Pygments Lexor to add syntax highlighting to methods
get_linkcode_resolve() - to link to GitHub source code using sphinx.ext.linkcode
add_linkcode_node_class() - adds a new linkcode-link class, allowing for CSS styling separately from viewcode links
github_style.css - CSS styling for linkcode links (icon + text)
Documentation
Full documentation can be found on ReadTheDocs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for sphinx-github-style-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0ae1fca4fcbd548493a6652f23b969ee9a63354337b52dd2e48af4ed5453343 |
|
MD5 | 9a17db493ef6ad9273806ff441428907 |
|
BLAKE2b-256 | 6a6be821942919d173f6804ceba475f76e48187af805f7dce4854a1cf9dc70f3 |
Hashes for sphinx_github_style-1.0.0-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8970b5500c61c0d6f9c8237a9f7f0b548b63d3e029b5637c5acc28070292f816 |
|
MD5 | 059a717996a4c360f4d3e6f153ec9610 |
|
BLAKE2b-256 | 80ad1092f6eb8ea8a86719a75fc6f76cc1b2c95b95cb44c27821230e3f634233 |
Hashes for sphinx_github_style-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d59ed6b203395c0f56d29d712229a16632d99f0c0bcc0357892ba14af0ed286 |
|
MD5 | e6f4aefb62734d829df26ba936395693 |
|
BLAKE2b-256 | 314e3f984b350bf40638f975db871c2e1770bebd93474483cff67e19a04044f2 |