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
pkg_name
pkg_name: str
The name of the top-level package. For this repo, it would be sphinx_github_style
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.1b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7397e4646df31cff04a569630c53f9e472896e55a8464f5a10d3b8846d0ca6fd |
|
MD5 | 744a16ef60698af9a8050df91267ff29 |
|
BLAKE2b-256 | b23a827b07a4e0593d10c3f1690c07e03e40c1f62b3d5e52625cf101efa309db |
Hashes for sphinx_github_style-1.0.1b1-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b07b93ffc92026ae7044dac0227ee661eba8fe682c1e5a24cf32c4498746c43a |
|
MD5 | f9c5e273b109d05d070cbdcfa31cee27 |
|
BLAKE2b-256 | 83d8f0b534673f84c097606c516f0ba0f9a5e2ad70a8763a87c06d221b7ad1ee |
Hashes for sphinx_github_style-1.0.1b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 550720e68432c4297adc6340c8f300afc72d0bcf5db9cc12a5cda72d4400c687 |
|
MD5 | a47ad44ea618232562776447a473888a |
|
BLAKE2b-256 | 9c2fed2d696b1066bff8c9d46f5ead8f8bd2feac180f14cd5832df940f5a477d |