diff options
Diffstat (limited to 'conf.py')
| -rw-r--r-- | conf.py | 39 |
1 files changed, 24 insertions, 15 deletions
@@ -55,9 +55,9 @@ copyright = u'2014, contributors like you' # built documents. # # The short X.Y version. -version = 'prerelease' +version = '' # The full version, including alpha/beta/rc tags. -release = 'prerelease' +release = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -67,7 +67,7 @@ release = 'prerelease' # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -89,35 +89,42 @@ exclude_patterns = ['_build'] #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # 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 +keep_warnings = False + +# Warn about all references where the target cannot be found. +nitpicky = True # -- Options for HTML output ---------------------------------------------- +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ['.'] + # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = '_better_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_options = { + 'showrelbartop': False, + 'showrelbarbottom': True, + 'cssfiles': ['_static/style.css', ] +} # 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 +html_short_title = 'fpga-lube' # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -140,14 +147,16 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +html_sidebars = { + '**': ['globaltoc.html', 'sidebarresources.html', 'searchbox.html'], +} # Additional templates that should be rendered to pages, maps page names to # template names. @@ -157,7 +166,7 @@ html_static_path = ['_static'] #html_domain_indices = True # If false, no index is generated. -#html_use_index = True +html_use_index = False # If true, the index is split into individual pages for each letter. #html_split_index = False @@ -180,7 +189,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'fpga-lubedoc' +htmlhelp_basename = 'fpga-lube' # -- Options for LaTeX output --------------------------------------------- |