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 geopatternjumbotron_background_image
:str
Base64 Encoded Image or Path to imagedata:image/...
Base64 Encoder
TOC Tree¶
Urls¶
canonical_url
:str
. Canonical Urlgithub_url
:str
. Username/Repositorybitbucket_url
:str
. Username/Repositorygitlab_url
:str
. Username/Repositorydisqus
:str
. Full Disqus Url
Note
github_url
, bitbucket_url
or gitlab_url
will result
in a each respective icon in the footer.
Colors¶
- Navbar
navbar_bg_color
:str
. HTML color codenavbar_text_color
:str
. HTML color codenavbar_brand_color
:str
. HTML color codenavbar_hover_color
:str
. HTML color code
- Jumbotron
jumbotron_text_color
:str
. HTML color codejumbotron_link_color
:str
. HTML color code
- Footer
footer_text_color
:str
. HTML color codefooter_icon_color
:str
. HTML color codefooter_icon_hover_color
:str
. HTML color code
- TOC
toc_bg_color
:str
. HTML color codetoc_text_color
:str
. HTML color codetoc_hover_color
:str
. HTML color code
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'
}