# -*- coding: utf-8 -*-
#
# -- General configuration ----------------------------
source_suffix = '.rst'
master_doc = 'index'
project = u'sphinx theme for basicstrap style'
copyright = u'2015, tell-k'
version = '0.5.0'
# -- Options for HTML output --------------------------
extensions = ['sphinxjp.themes.basicstrap']
html_theme = 'basicstrap'
# -- HTML theme options for `basicstrap` style -------
html_theme_options = {
# Set the lang attribute of the html tag. Defaults to 'en'
'lang': 'en',
# Disable showing the sidebar. Defaults to 'false'
'nosidebar': False,
# Show header searchbox. Defaults to false. works only "nosidber=True",
'header_searchbox': False,
# Put the sidebar on the right side. Defaults to false.
'rightsidebar': False,
# Set the width of the sidebar. Defaults to 3
'sidebar_span': 3,
# Fix navbar to top of screen. Defaults to true
'nav_fixed_top': True,
# Fix the width of the sidebar. Defaults to false
'nav_fixed': False,
# Set the width of the sidebar. Defaults to '900px'
'nav_width': '900px',
# Fix the width of the content area. Defaults to false
'content_fixed': False,
# Set the width of the content area. Defaults to '900px'
'content_width': '900px',
# Fix the width of the row. Defaults to false
'row_fixed': False,
# Disable the responsive design. Defaults to false
'noresponsive': False,
# Disable the responsive footer relbar. Defaults to false
'noresponsiverelbar': False,
# Disable flat design. Defaults to false.
# Works only "bootstrap_version = 3"
'noflatdesign': False,
# Enable Google Web Font. Defaults to false
'googlewebfont': False,
# Set the URL of Google Web Font's CSS.
# Defaults to 'http://fonts.googleapis.com/css?family=Text+Me+One'
'googlewebfont_url': 'http://fonts.googleapis.com/css?family=Lily+Script+One', # NOQA
# Set the Style of Google Web Font's CSS.
# Defaults to "font-family: 'Text Me One', sans-serif;"
'googlewebfont_style': u"font-family: 'Lily Script One' cursive;",
# Set 'navbar-inverse' attribute to header navbar. Defaults to false.
'header_inverse': False,
# Set 'navbar-inverse' attribute to relbar navbar. Defaults to false.
'relbar_inverse': False,
# Enable inner theme by Bootswatch. Defaults to false
'inner_theme': False,
# Set the name of innner theme. Defaults to 'bootswatch-simplex'
'inner_theme_name': 'bootswatch-simplex',
# Select Twitter bootstrap version 2 or 3. Defaults to '3'
'bootstrap_version': '3',
# Show "theme preview" button in header navbar. Defaults to false.
'theme_preview': True,
# Set the Size of Heading text. Defaults to None
# 'h1_size': '3.0em',
# 'h2_size': '2.6em',
# 'h3_size': '2.2em',
# 'h4_size': '1.8em',
# 'h5_size': '1.4em',
# 'h6_size': '1.1em',
}
###########################################################################
# auto-created readthedocs.org specific configuration #
###########################################################################
#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#
import importlib
import sys
import os.path
from six import string_types
from sphinx import version_info
# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
if isinstance(source_suffix, string_types):
SUFFIX = source_suffix
elif isinstance(source_suffix, (list, tuple)):
# Sphinx >= 1.3 supports list/tuple to define multiple suffixes
SUFFIX = source_suffix[0]
elif isinstance(source_suffix, dict):
# Sphinx >= 1.8 supports a mapping dictionary for mulitple suffixes
SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility
else:
# default to .rst
SUFFIX = '.rst'
else:
SUFFIX = '.rst'
# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
html_static_path = []
if os.path.exists('_static'):
html_static_path.append('_static')
# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
(
'html_theme' in globals() and
html_theme in ['default'] and
# Allow people to bail with a hack of having an html_style
'html_style' not in globals()
) or 'html_theme' not in globals()
)
if using_rtd_theme:
theme = importlib.import_module('sphinx_rtd_theme')
html_theme = 'sphinx_rtd_theme'
html_style = None
html_theme_options = {}
if 'html_theme_path' in globals():
html_theme_path.append(theme.get_html_theme_path())
else:
html_theme_path = [theme.get_html_theme_path()]
if globals().get('websupport2_base_url', False):
websupport2_base_url = 'https://readthedocs.org/websupport'
websupport2_static_url = 'https://assets.readthedocs.org/static/'
#Add project information to the template context.
context = {
'using_theme': using_rtd_theme,
'html_theme': html_theme,
'current_version': "latest",
'version_slug': "latest",
'MEDIA_URL': "https://media.readthedocs.org/",
'STATIC_URL': "https://assets.readthedocs.org/static/",
'PRODUCTION_DOMAIN': "readthedocs.org",
'versions': [
("latest", "/en/latest/"),
],
'downloads': [
("html", "//readthedocs.org/projects/sphinxjpthemesbasicstrap/downloads/htmlzip/latest/"),
],
'subprojects': [
],
'slug': 'sphinxjpthemesbasicstrap',
'name': u'sphinxjp.themes.basicstrap',
'rtd_language': u'en',
'programming_language': u'words',
'canonical_url': 'https://sphinxjpthemesbasicstrap.readthedocs.io/en/latest/',
'analytics_code': 'None',
'single_version': False,
'conf_py_path': '/docs/',
'api_host': 'https://readthedocs.org',
'github_user': 'tell-k',
'github_repo': 'sphinxjp.themes.basicstrap',
'github_version': 'master',
'display_github': True,
'bitbucket_user': 'None',
'bitbucket_repo': 'None',
'bitbucket_version': 'master',
'display_bitbucket': False,
'gitlab_user': 'None',
'gitlab_repo': 'None',
'gitlab_version': 'master',
'display_gitlab': False,
'READTHEDOCS': True,
'using_theme': (html_theme == "default"),
'new_theme': (html_theme == "sphinx_rtd_theme"),
'source_suffix': SUFFIX,
'ad_free': False,
'user_analytics_code': '',
'global_analytics_code': 'UA-17997319-1',
'commit': '5fc645a7',
}
if 'html_context' in globals():
html_context.update(context)
else:
html_context = context
# Add custom RTD extension
if 'extensions' in globals():
# Insert at the beginning because it can interfere
# with other extensions.
# See https://github.com/rtfd/readthedocs.org/pull/4054
extensions.insert(0, "readthedocs_ext.readthedocs")
else:
extensions = ["readthedocs_ext.readthedocs"]