sphinx-github-style Logo
1.2.2

README

  • About
    • GitHub Source Code Links
    • Syntax Highlighting
  • Installation
  • Configuration
    • Optional Configuration Variables
      • linkcode_blob
      • linkcode_url
      • linkcode_link_text
      • linkcode_resolve

Documentation

  • The sphinx_github_style Package
    • setup()
    • CSS Styling for Linkcode Links
      • add_linkcode_node_class()
      • The github_style.css StyleSheet
    • GitHub Dark Theme Pygments Style
      • GitHubStyle
        • GitHubStyle.background_color
        • GitHubStyle.default_style
        • GitHubStyle.styles
    • Pygments Lexer for Syntax Highlighting of Methods, Classes, Type Hints, and more
      • get_builtins()
      • GitHubLexer
        • GitHubLexer.name
        • GitHubLexer.url
        • GitHubLexer.aliases
        • GitHubLexer.get_tokens_unprocessed()
    • The sphinx_github_style.utils subpackage
      • The sphinx_github_style.utils.git submodule
        • get_head()
        • get_last_tag()
        • get_repo_dir()
      • The sphinx_github_style.utils.linkcode submodule
        • get_linkcode_revision()
        • get_linkcode_url()
        • get_linkcode_resolve()
      • The sphinx_github_style.utils.sphinx submodule
        • get_conf_val()
        • set_conf_val()

Extras

  • Table Of Contents
sphinx-github-style
  • Table Of Contents
  • Edit on GitHub
Next

Table Of Contents

README

  • About
    • GitHub Source Code Links
    • Syntax Highlighting
  • Installation
  • Configuration
    • Optional Configuration Variables
      • linkcode_blob
      • linkcode_url
      • linkcode_link_text
      • linkcode_resolve

Documentation

  • The sphinx_github_style Package
    • setup()
    • CSS Styling for Linkcode Links
      • add_linkcode_node_class()
      • The github_style.css StyleSheet
    • GitHub Dark Theme Pygments Style
      • GitHubStyle
    • Pygments Lexer for Syntax Highlighting of Methods, Classes, Type Hints, and more
      • get_builtins()
      • GitHubLexer
    • The sphinx_github_style.utils subpackage
      • The sphinx_github_style.utils.git submodule
      • The sphinx_github_style.utils.linkcode submodule
      • The sphinx_github_style.utils.sphinx submodule

Extras

  • Table Of Contents

Indices and tables

  • Index

  • Module Index

  • Full Table of Contents

Next

© Copyright 2023, Adam Korn.

Built with Sphinx using a theme provided by Read the Docs.