GitHub source code links and syntax highlighting for Sphinx documentation
Project description
GitHub source code links and syntax highlighting for Sphinx documentation
About
sphinx-github-style is a Sphinx extension that links your documentation to GitHub source code. It also adds syntax highlighting for code blocks similar to GitHub’s pretty lights dark theme.
…
GitHub Source Code Links
Using sphinx.ext.linkcode, a View on GitHub link is added to the documentation of every class, method, function, and property:
They link to and highlight the corresponding code block in your GitHub repository:
📝 Note |
---|
These links can be styled with CSS and used with/instead of the links added by sphinx.ext.viewcode |
Syntax Highlighting
sphinx-github-style also contains a Pygments style to highlight code blocks 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",
]
Optional Configuration Variables
Add any (or none) of the following configuration variables to your conf.py
- top_level
The name of the package’s top-level module. For this repo, it would be sphinx_github_style
Type: str
- linkcode_blob
The blob to link to on GitHub - any of "head", "last_tag", or "{blob}"
Type: str
Default: "head"
"head" (default): links to the most recent commit hash; if this commit is tagged, uses the tag instead
"last_tag": links to the most recent commit tag on the currently checked out branch
"blob": links to any blob you want, for example "master" or "v2.0.1"
- linkcode_url
The link to your GitHub repository formatted as https://github.com/user/repo
Type: str
Default: f"https://github.com/{html_context['github_user']}/{html_context['github_repo']}/{html_context['github_version']}"
If not provided, will attempt to create the link from the html_context dict
- linkcode_link_text
The text to use for the linkcode link
Type: str
Default: "View on GitHub"
- linkcode_resolve
A linkcode_resolve() function to use when resolving the link target with sphinx.ext.linkcode
Type: Callable
Default: Return value from get_linkcode_resolve()
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 Distribution
Hashes for sphinx-github-style-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96d24c6feccc80a77a15e8945e75d2b63947af63e0f447780fc92e612c623513 |
|
MD5 | 873ea8bafa9310c8e346676de5bada2e |
|
BLAKE2b-256 | 4d87d93219c202a260614b7dba85c4398735e3160cac8473a1ad5c44a5fec77a |
Hashes for sphinx_github_style-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e9a1091dbb6f49429684caeb730e12e606eef1d21ae62f00f4f15ba35350ffc |
|
MD5 | c6dfa21b4fe73c44889a1e48719326c2 |
|
BLAKE2b-256 | 2b865559cc49190dd6a0795078b7b21affa694d5dace8744d3cbd95783ea67f3 |