sphinx-github-style - GitHub source code links and syntax highlighting for Sphinx documentation
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
- 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()
Metadata
Release files for sphinx-github-style 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-github-style-1.2.2.tar.gz | 12.0 kB | Without provenance | Details for sphinx-github-style-1.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_github_style-1.2.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_github_style-1.2.2-py3-none-any.whl |
Total release size: 24.3 kB
Release files / sphinx-github-style-1.2.2.tar.gz
| Download URL | sphinx-github-style-1.2.2.tar.gz |
|---|---|
| Size | 12.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aad6231fcc0a4f59df82531eb3a82dda8a461a94d9e304895c34ac1158d7347c
|
|
BLAKE2b-256 checksum How to use checksums |
0227f0d375d18c45ba795826070e03dd32c13575f3ec4fb7273654e33c12fb08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.1
|
Release files / sphinx_github_style-1.2.2-py3-none-any.whl
| Download URL | sphinx_github_style-1.2.2-py3-none-any.whl |
|---|---|
| Size | 12.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f6fd1a2c1a5878428a010050549c8353354a1ca9650f6bb01049c649935677d
|
|
BLAKE2b-256 checksum How to use checksums |
4f43a1aa363d38363f66a668a286691006c11866a6cb5cc75d7325a17395f337
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.1
|
Security for sphinx-github-style 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.