/docs/conf.py
Relevant Search: With Applications for Solr and Elasticsearch
For more in depth reading about search, ranking and generally everything you could ever want to know about how lucene, elasticsearch or solr work under the hood I highly suggest this book. Easily one of the most interesting technical books I have read in a long time. If you are tasked with solving search relevance problems even if not in Solr or Elasticsearch it should be your first reference. Amazon Affiliate LinkPython | 269 lines | 38 code | 73 blank | 158 comment | 0 complexity | 0ffb4c49816ba57e09cb3d0ee4759c5b MD5 | raw file
1# -*- coding: utf-8 -*- 2# 3# Django documentation build configuration file, created by 4# sphinx-quickstart on Thu Mar 27 09:06:53 2008. 5# 6# This file is execfile()d with the current directory set to its containing dir. 7# 8# The contents of this file are pickled, so don't put values in the namespace 9# that aren't pickleable (module imports are okay, they're removed automatically). 10# 11# All configuration values have a default; values that are commented out 12# serve to show the default. 13 14import sys 15import os 16 17# If extensions (or modules to document with autodoc) are in another directory, 18# add these directories to sys.path here. If the directory is relative to the 19# documentation root, use os.path.abspath to make it absolute, like shown here. 20sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))) 21 22# -- General configuration ----------------------------------------------------- 23 24# If your documentation needs a minimal Sphinx version, state it here. 25needs_sphinx = '1.0' 26 27# Add any Sphinx extension module names here, as strings. They can be extensions 28# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 29extensions = ["djangodocs"] 30 31# Add any paths that contain templates here, relative to this directory. 32# templates_path = [] 33 34# The suffix of source filenames. 35source_suffix = '.txt' 36 37# The encoding of source files. 38#source_encoding = 'utf-8-sig' 39 40# The master toctree document. 41master_doc = 'contents' 42 43# General substitutions. 44project = 'Django' 45copyright = 'Django Software Foundation and contributors' 46 47 48# The version info for the project you're documenting, acts as replacement for 49# |version| and |release|, also used in various other places throughout the 50# built documents. 51# 52# The short X.Y version. 53version = '1.3' 54# The full version, including alpha/beta/rc tags. 55release = '1.3.1' 56# The next version to be released 57django_next_version = '1.4' 58 59# The language for content autogenerated by Sphinx. Refer to documentation 60# for a list of supported languages. 61#language = None 62 63# There are two options for replacing |today|: either, you set today to some 64# non-false value, then it is used: 65#today = '' 66# Else, today_fmt is used as the format for a strftime call. 67today_fmt = '%B %d, %Y' 68 69# List of patterns, relative to source directory, that match files and 70# directories to ignore when looking for source files. 71exclude_patterns = ['_build'] 72 73# The reST default role (used for this markup: `text`) to use for all documents. 74#default_role = None 75 76# If true, '()' will be appended to :func: etc. cross-reference text. 77add_function_parentheses = True 78 79# If true, the current module name will be prepended to all description 80# unit titles (such as .. function::). 81add_module_names = False 82 83# If true, sectionauthor and moduleauthor directives will be shown in the 84# output. They are ignored by default. 85show_authors = False 86 87# The name of the Pygments (syntax highlighting) style to use. 88pygments_style = 'trac' 89 90# Sphinx will recurse into subversion configuration folders and try to read 91# any document file within. These should be ignored. 92# Note: exclude_dirnames is new in Sphinx 0.5 93exclude_dirnames = ['.svn'] 94 95# -- Options for HTML output --------------------------------------------------- 96 97# The theme to use for HTML and HTML Help pages. See the documentation for 98# a list of builtin themes. 99html_theme = "djangodocs" 100 101# Theme options are theme-specific and customize the look and feel of a theme 102# further. For a list of options available for each theme, see the 103# documentation. 104#html_theme_options = {} 105 106# Add any paths that contain custom themes here, relative to this directory. 107html_theme_path = ["_theme"] 108 109# The name for this set of Sphinx documents. If None, it defaults to 110# "<project> v<release> documentation". 111#html_title = None 112 113# A shorter title for the navigation bar. Default is the same as html_title. 114#html_short_title = None 115 116# The name of an image file (relative to this directory) to place at the top 117# of the sidebar. 118#html_logo = None 119 120# The name of an image file (within the static path) to use as favicon of the 121# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 122# pixels large. 123#html_favicon = None 124 125# Add any paths that contain custom static files (such as style sheets) here, 126# relative to this directory. They are copied after the builtin static files, 127# so a file named "default.css" will overwrite the builtin "default.css". 128#html_static_path = ["_static"] 129 130# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 131# using the given strftime format. 132html_last_updated_fmt = '%b %d, %Y' 133 134# If true, SmartyPants will be used to convert quotes and dashes to 135# typographically correct entities. 136html_use_smartypants = True 137 138# HTML translator class for the builder 139html_translator_class = "djangodocs.DjangoHTMLTranslator" 140 141# Content template for the index page. 142#html_index = '' 143 144# Custom sidebar templates, maps document names to template names. 145#html_sidebars = {} 146 147# Additional templates that should be rendered to pages, maps page names to 148# template names. 149html_additional_pages = {} 150 151# If false, no module index is generated. 152#html_domain_indices = True 153 154# If false, no index is generated. 155#html_use_index = True 156 157# If true, the index is split into individual pages for each letter. 158#html_split_index = False 159 160# If true, links to the reST sources are added to the pages. 161#html_show_sourcelink = True 162 163# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 164#html_show_sphinx = True 165 166# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 167#html_show_copyright = True 168 169# If true, an OpenSearch description file will be output, and all pages will 170# contain a <link> tag referring to it. The value of this option must be the 171# base URL from which the finished HTML is served. 172#html_use_opensearch = '' 173 174# This is the file name suffix for HTML files (e.g. ".xhtml"). 175#html_file_suffix = None 176 177# Output file base name for HTML help builder. 178htmlhelp_basename = 'Djangodoc' 179 180modindex_common_prefix = ["django."] 181 182 183# -- Options for LaTeX output -------------------------------------------------- 184 185# The paper size ('letter' or 'a4'). 186#latex_paper_size = 'letter' 187 188# The font size ('10pt', '11pt' or '12pt'). 189#latex_font_size = '10pt' 190 191# Grouping the document tree into LaTeX files. List of tuples 192# (source start file, target name, title, author, document class [howto/manual]). 193#latex_documents = [] 194latex_documents = [ 195 ('contents', 'django.tex', u'Django Documentation', 196 u'Django Software Foundation', 'manual'), 197] 198 199# The name of an image file (relative to this directory) to place at the top of 200# the title page. 201#latex_logo = None 202 203# For "manual" documents, if this is true, then toplevel headings are parts, 204# not chapters. 205#latex_use_parts = False 206 207# If true, show page references after internal links. 208#latex_show_pagerefs = False 209 210# If true, show URL addresses after external links. 211#latex_show_urls = False 212 213# Additional stuff for the LaTeX preamble. 214#latex_preamble = '' 215 216# Documents to append as an appendix to all manuals. 217#latex_appendices = [] 218 219# If false, no module index is generated. 220#latex_domain_indices = True 221 222 223# -- Options for manual page output -------------------------------------------- 224 225# One entry per manual page. List of tuples 226# (source start file, name, description, authors, manual section). 227man_pages = [ 228 ('contents', 'django', 'Django Documentation', ['Django Software Foundation'], 1) 229] 230 231 232# -- Options for Epub output --------------------------------------------------- 233 234# Bibliographic Dublin Core info. 235epub_title = u'Django' 236epub_author = u'Django Software Foundation' 237epub_publisher = u'Django Software Foundation' 238epub_copyright = u'2010, Django Software Foundation' 239 240# The language of the text. It defaults to the language option 241# or en if the language is not set. 242#epub_language = '' 243 244# The scheme of the identifier. Typical schemes are ISBN or URL. 245#epub_scheme = '' 246 247# The unique identifier of the text. This can be a ISBN number 248# or the project homepage. 249#epub_identifier = '' 250 251# A unique identification for the text. 252#epub_uid = '' 253 254# HTML files that should be inserted before the pages created by sphinx. 255# The format is a list of tuples containing the path and title. 256#epub_pre_files = [] 257 258# HTML files shat should be inserted after the pages created by sphinx. 259# The format is a list of tuples containing the path and title. 260#epub_post_files = [] 261 262# A list of files that should not be packed into the epub file. 263#epub_exclude_files = [] 264 265# The depth of the table of contents in toc.ncx. 266#epub_tocdepth = 3 267 268# Allow duplicate toc entries. 269#epub_tocdup = True