conf.py sample

Sample

# -*- coding: utf-8 -*-
#
# -- General configuration -----------------------------------------------------

source_suffix = '.rst'
master_doc = 'index'

project = u'sphinx theme for basicstrap style'
copyright = u'2014, tell-k'

version = '0.4.0'

# -- Options for HTML output ---------------------------------------------------

extensions = ['sphinxjp.themes.basicstrap']
html_theme = 'basicstrap'

# -- HTML theme options for `basicstrap` style -------------------------------------

html_theme_options = {
    'lang': 'en',
    'nosidebar': False,
    'rightsidebar': False,
    'sidebar_span': 3,
    'nav_fixed_top': True,

    'nav_fixed': False,
    'nav_width': '900px',

    'content_fixed': False,
    'content_width': '900px',

    'row_fixed': False,
    'noresponsive': False,
    'noflatdesign': False,

    'googlewebfont': False,
    'googlewebfont_url': 'http://fonts.googleapis.com/css?family=Lily+Script+One',
    'googlewebfont_style': u"font-family: 'Lily Script One' cursive;",

    'header_inverse': False,
    'relbar_inverse': False,

    'inner_theme': True,
    'inner_theme_name': 'bootswatch-flatly',

    'bootstrap_version': '3',
    'quick_preview': True,

    # 'h1_size': '3.0em',
    # 'h2_size': '2.6em',
    # 'h3_size': '2.2em',
    # 'h4_size': '1.8em',
    # 'h5_size': '1.4em',
    # 'h6_size': '1.1em',
}

HTML theme options

lang:Set the lang attribute of the html tag. Defaults to ‘en’
nosidebar:Disable showing the sidebar. Defaults to ‘false’
rightsidebar:Put the sidebar on the right side. Defaults to false.
sidebar_span:Set the width of the sidebar. Defaults to 3
nav_fixed_top:Fix navbar to top of screen. Defaults to true
nav_fixed:Fix the width of the sidebar. Defaults to false
nav_width:Set the width of the sidebar. Defaults to ‘900px’
content_fixed:Fix the width of the content area. Defaults to false
content_width:Set the width of the content area. Defaults to ‘900px’
row_fixed:Fix the width of the row. Defaults to false
noresponsive:Disable the responsive design. Defaults to false
googlewebfont:Enable Google Web Font. Defaults to false
googlewebfont_url:
 Set the URL of Google Web Font’s CSS. Defaults to ‘http://fonts.googleapis.com/css?family=Text+Me+One
googlewebfont_style:
 Set the Style of Google Web Font’s CSS. Defaults to “font-family: ‘Text Me One’, sans-serif;”
header_inverse:Set ‘navbar-inverse’ attribute to header navbar. Defaults to false.
relbar_inverse:Set ‘navbar-inverse’ attribute to relbar navbar. Defaults to false.
inner_theme:Enable inner theme by Bootswatch. Defaults to false
inner_theme_name:
 Set the Name of Bootswatch Style. Defaults to ‘bootswatch-ameria’
h1_size(- h6_size):
 Set the Size of Heading text. Defaults to None