Example #1
0
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1.0'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']


# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
# Adds an HTML table visitor to apply Bootstrap table classes
html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme = 'guzzle_sphinx_theme'

html_static_path = ['_static']

# Output file base name for HTML help builder.
htmlhelp_basename = 'keepassxdoc'

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'keepassx', u'keepassx Documentation',
     [u'James Saryerwinnie'], 1)
]

Example #2
0
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
extensions.append("guzzle_sphinx_theme")
html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme = 'guzzle_sphinx_theme'
# Guzzle theme options (see theme.conf for more information)

html_theme_options = {}

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#html_title = u'Chalice v0.0.1'

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = 'User Documentation'

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
Example #3
0
# Register the theme as an extension to generate a sitemap.xml
extensions.append('guzzle_sphinx_theme')

# Guzzle theme options (see theme.conf for more information)
html_theme_options = {
    # Set the name of the project to appear in the sidebar
    'project_nav_name': 'Home',
    # Google Analytics
    # 'google_analytics_account': 'FIXME',
    # Specify a base_url used to generate sitemap.xml links.
    'base_url': 'https://docs.kuralabs.io/ninjecto/',
}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = html_theme_path()

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d'
Example #4
0
#    'github_repo': 'cordjs-docs-ru',
#    'github_button': 'true',
#    'github_banner': 'true',
#    'font_family': '"Open Sans","Helvetica Neue",Helvetica,Arial,sans-serif',
#    'head_font_family': '"Source Sans Pro","Helvetica Neue","Arial",sans-serif'
#}
html_theme_options = {
    # Set the name of the project to appear in the sidebar
    'project_nav_name': 'CordJS',
    'disqus_comments_shortname': 'cordjs',
    'homepage': 'index',
}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = ['_themes'] + guzzle_sphinx_theme.html_theme_path()

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
Example #5
0
# Adds an HTML table visitor to apply Bootstrap table classes
html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
html_theme = 'guzzle_sphinx_theme'

# Register the theme as an extension to generate a sitemap.xml
extensions.append('guzzle_sphinx_theme')

# Guzzle theme options (see theme.conf for more information)
html_theme_options = {
    # Set the name of the project to appear in the sidebar
    'project_nav_name': 'Home'
}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = html_theme_path()

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d'