/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 | 244 lines | 24 code | 65 blank | 155 comment | 1 complexity | bdf68637668ff560a5e86d6cd650f3fb MD5 | raw file
1# -*- coding: utf-8 -*- 2# 3# argh documentation build configuration file, created by 4# sphinx-quickstart on Tue Nov 9 23:06:31 2010. 5# 6# This file is execfile()d with the current directory set to its containing dir. 7# 8# Note that not all possible configuration values are present in this 9# autogenerated file. 10# 11# All configuration values have a default; values that are commented out 12# serve to show the default. 13 14import sys, os 15 16# If extensions (or modules to document with autodoc) are in another directory, 17# add these directories to sys.path here. If the directory is relative to the 18# documentation root, use os.path.abspath to make it absolute, like shown here. 19sys.path.append(os.path.abspath('..')) 20from argh import __version__ as full_version 21 22# -- General configuration ----------------------------------------------------- 23 24# If your documentation needs a minimal Sphinx version, state it here. 25#needs_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 = ['sphinx.ext.autodoc', 'sphinx.ext.coverage'] 30 31# Add any paths that contain templates here, relative to this directory. 32templates_path = ['_templates'] 33 34# The suffix of source filenames. 35source_suffix = '.rst' 36 37# The encoding of source files. 38#source_encoding = 'utf-8-sig' 39 40# The master toctree document. 41master_doc = 'index' 42 43# General information about the project. 44project = u'argh' 45copyright = u'2013, Andrey Mikhaylenko' 46 47# The version info for the project you're documenting, acts as replacement for 48# |version| and |release|, also used in various other places throughout the 49# built documents. 50# 51# The short X.Y version. 52version = full_version.rpartition('.')[0] 53# The full version, including alpha/beta/rc tags. 54release = full_version 55 56# The language for content autogenerated by Sphinx. Refer to documentation 57# for a list of supported languages. 58#language = None 59 60# There are two options for replacing |today|: either, you set today to some 61# non-false value, then it is used: 62#today = '' 63# Else, today_fmt is used as the format for a strftime call. 64#today_fmt = '%B %d, %Y' 65 66# List of patterns, relative to source directory, that match files and 67# directories to ignore when looking for source files. 68exclude_patterns = ['_build'] 69 70# The reST default role (used for this markup: `text`) to use for all documents. 71#default_role = None 72 73# If true, '()' will be appended to :func: etc. cross-reference text. 74#add_function_parentheses = True 75 76# If true, the current module name will be prepended to all description 77# unit titles (such as .. function::). 78#add_module_names = True 79 80# If true, sectionauthor and moduleauthor directives will be shown in the 81# output. They are ignored by default. 82#show_authors = False 83 84# The name of the Pygments (syntax highlighting) style to use. 85pygments_style = 'sphinx' 86 87# A list of ignored prefixes for module index sorting. 88#modindex_common_prefix = [] 89 90 91# -- Options for HTML output --------------------------------------------------- 92 93# The theme to use for HTML and HTML Help pages. Major themes that come with 94# Sphinx are currently 'default' and 'sphinxdoc'. 95 96# see http://read-the-docs.readthedocs.org/en/latest/faq.html#how-do-i-change-behavior-for-read-the-docs 97on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 98if on_rtd: 99 html_theme = 'default' 100else: 101 html_theme = 'nature' 102 103# Theme options are theme-specific and customize the look and feel of a theme 104# further. For a list of options available for each theme, see the 105# documentation. 106#html_theme_options = {} 107 108# Add any paths that contain custom themes here, relative to this directory. 109#html_theme_path = [] 110 111# The name for this set of Sphinx documents. If None, it defaults to 112# "<project> v<release> documentation". 113#html_title = None 114 115# A shorter title for the navigation bar. Default is the same as html_title. 116#html_short_title = None 117 118# The name of an image file (relative to this directory) to place at the top 119# of the sidebar. 120#html_logo = None 121 122# The name of an image file (within the static path) to use as favicon of the 123# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 124# pixels large. 125#html_favicon = None 126 127# Add any paths that contain custom static files (such as style sheets) here, 128# relative to this directory. They are copied after the builtin static files, 129# so a file named "default.css" will overwrite the builtin "default.css". 130html_static_path = ['_static'] 131 132# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 133# using the given strftime format. 134#html_last_updated_fmt = '%b %d, %Y' 135 136# If true, SmartyPants will be used to convert quotes and dashes to 137# typographically correct entities. 138#html_use_smartypants = True 139 140# Custom sidebar templates, maps document names to template names. 141#html_sidebars = {} 142 143# Additional templates that should be rendered to pages, maps page names to 144# template names. 145#html_additional_pages = {} 146 147# If false, no module index is generated. 148#html_use_modindex = True 149 150# If false, no index is generated. 151#html_use_index = True 152 153# If true, the index is split into individual pages for each letter. 154#html_split_index = False 155 156# If true, links to the reST sources are added to the pages. 157#html_show_sourcelink = True 158 159# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 160#html_show_sphinx = True 161 162# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 163#html_show_copyright = True 164 165# If true, an OpenSearch description file will be output, and all pages will 166# contain a <link> tag referring to it. The value of this option must be the 167# base URL from which the finished HTML is served. 168#html_use_opensearch = '' 169 170# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 171#html_file_suffix = '' 172 173# Output file base name for HTML help builder. 174htmlhelp_basename = 'arghdoc' 175 176 177# -- Options for LaTeX output -------------------------------------------------- 178 179# The paper size ('letter' or 'a4'). 180#latex_paper_size = 'letter' 181 182# The font size ('10pt', '11pt' or '12pt'). 183#latex_font_size = '10pt' 184 185# Grouping the document tree into LaTeX files. List of tuples 186# (source start file, target name, title, author, documentclass [howto/manual]). 187latex_documents = [ 188 ('index', 'argh.tex', u'argh Documentation', 189 u'Andrey Mikhaylenko', 'manual'), 190] 191 192# The name of an image file (relative to this directory) to place at the top of 193# the title page. 194#latex_logo = None 195 196# For "manual" documents, if this is true, then toplevel headings are parts, 197# not chapters. 198#latex_use_parts = False 199 200# Additional stuff for the LaTeX preamble. 201#latex_preamble = '' 202 203# Documents to append as an appendix to all manuals. 204#latex_appendices = [] 205 206# If false, no module index is generated. 207#latex_use_modindex = True 208 209 210# -- Options for Epub output --------------------------------------------------- 211 212# Bibliographic Dublin Core info. 213#epub_title = '' 214#epub_author = '' 215#epub_publisher = '' 216#epub_copyright = '' 217 218# The language of the text. It defaults to the language option 219# or en if the language is not set. 220#epub_language = '' 221 222# The scheme of the identifier. Typical schemes are ISBN or URL. 223#epub_scheme = '' 224 225# The unique identifier of the text. This can be a ISBN number 226# or the project homepage. 227#epub_identifier = '' 228 229# A unique identification for the text. 230#epub_uid = '' 231 232# HTML files that should be inserted before the pages created by sphinx. 233# The format is a list of tuples containing the path and title. 234#epub_pre_files = [] 235 236# HTML files shat should be inserted after the pages created by sphinx. 237# The format is a list of tuples containing the path and title. 238#epub_post_files = [] 239 240# A list of files that should not be packed into the epub file. 241#epub_exclude_files = [] 242 243# The depth of the table of contents in toc.ncx. 244#epub_tocdepth = 3