Welcome to Yummy Sphinx Theme documentation!

Welcome to Yummy Sphinx Theme documentation!

Configuration

Custom Styles

  • font_awesome_embed_code: str. A font-awesome embed code (0cb92b034c.js)
  • jumbotron_use_geopattern: bool Enable/Disable the geopattern
  • jumbotron_background_image: str Base64 Encoded Image or Path to image data:image/... Base64 Encoder

TOC Tree

  • toc_depth: int. Depth of TOC tree
  • toc_collapse: bool. Collapse TOC Tree
  • toc_hidden: bool. Include hidden

Urls

  • canonical_url: str. Canonical Url
  • github_url: str. Username/Repository
  • bitbucket_url: str. Username/Repository
  • gitlab_url: str. Username/Repository
  • disqus: str. Full Disqus Url

Note

github_url, bitbucket_url or gitlab_url will result in a each respective icon in the footer.

Analytics

  • google_tracking_id: str. Google Analytics Code

Colors

Example

html_theme_options = {
    'navs': '{
        'Home': 'http://tagnumelite.elitekast.com',
        'Blog': 'http://blog.elitekast.com',
        'Forum': 'http://forum.elitekast.com',
    },
    'github_url': 'TagnumElite/yummy_sphinx_theme',
    'bitbucket_url': 'TagnumElite/yummy_sphinx_theme',
    'gitlab_url': 'TagnumElite/yummy_sphinx_theme',
    'navbar_icon': 'spin fa-book'
}

Indices and tables