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-0.0.1b15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86ce4392d64e4cfd094e64f460bf18e4f9edf3cdc13a251eee15002c9e64a5a4 |
|
MD5 | 8278131833f33bc4a539498fc34de289 |
|
BLAKE2b-256 | 4ac5084af141fa4cf5079e3bdd953711088e64d6df2c6a408fc984c23fb96f19 |
Hashes for sphinx_github_style-0.0.1b15-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0d1c5276131aa2e7c1147def552ccb90507a7cb644275918d905ba7131bfb88 |
|
MD5 | 414916ef2d1017a1104925483b86f766 |
|
BLAKE2b-256 | 6b79f0af92fe4d69f9cba42365490ffb2fbfc576bd0c8bf5964f9b28008da704 |
Hashes for sphinx_github_style-0.0.1b15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dba72fc701605042642a65e63ab39430ea745b90d73bf8aa43c35f11b4a117c |
|
MD5 | 92f5dfd61550209830c1d75c29275ba7 |
|
BLAKE2b-256 | 371db4f2744c0b8daf834bcab1ede8b036579ed8e05ee9abcd7629d4264469cd |