Sphinx Github Integration and Github Dark Theme Pygments Style
Project description
Github Pygments Style and Sphinx Integration
Components
~.linkcode_resolve() ~.add_linkcode_node_class()
TDKStyle.py - Highlights code similar to Github Pretty Lights Dark
TDKMethLexor - Highlights methods in code blocks
~.add_linkcode_node_class() - Updates linkcode nodes a new linkcode-link class to use for CSS styling separately from viewcode links
Add default ~.linkcode_resolve()
github_style.css - Linkcode link icon + text
Config Values
linkcode_default_blob: str = any('last_tag', 'master', 'head')
linkcode_link_text: str = "View on GitHub"
linkcode_url: str = "https://github.com/tdkorn/sphinx-github-style"
linkcode_resolve: func = None
linkcode_default_blob: str = any(‘last_tag’, ‘master’, ‘head’)
Default is “master”
- How blob is chosen
If head is a tag, uses the tag
- If head is not a tag, then
If default blob is “last_tag” -> Retrieve most recent tag; if no tags exist, uses master
If default blob is “head” -> uses last commit hash; if wasn’t able to get head, uses “master”
If default blob is “master” -> uses “master”
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.1b8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87a6d8c207457809ee8f6b43c915de921cbf3cccbea8635987e028a6723bf870 |
|
MD5 | a9697b10c40b4acdb3ff728b48dc6492 |
|
BLAKE2b-256 | 22376ce6b754910279f6c9d3e0f9d6aff14f252852dc6eac24a32a2f6eefe117 |
Hashes for sphinx_github_style-0.0.1b8-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34da18103d50818d6f9c8f6b8579cdeba1273c6cc9d109e0cb42f9480f901a8c |
|
MD5 | 5235f9b4e0118dbe85108cf7d682b75b |
|
BLAKE2b-256 | a749c993296a9210e8da8c07699cb54378fa4aac0d200d51d105907af6434ec2 |
Hashes for sphinx_github_style-0.0.1b8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aab6906ac82928358519d8e2a1d258e1c621ee59f0c270a3fd81e311b9fb58d |
|
MD5 | f41bec8d3049a418f960a74b2397038f |
|
BLAKE2b-256 | 0291272614ef2ad64e0b7125c075396461dd87897c09e076eef5b68405d65c7f |