/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 Link

  1# -*- coding: utf-8 -*-
  2#
  3# Johnny Cache documentation build configuration file, created by
  4# sphinx-quickstart on Thu Feb 18 22:05:30 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.
 19projpath = os.path.abspath('..')
 20sys.path.append(projpath)
 21
 22# -- General configuration -----------------------------------------------------
 23
 24# Add any Sphinx extension module names here, as strings. They can be extensions
 25# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 26extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
 27
 28# Add any paths that contain templates here, relative to this directory.
 29templates_path = ['_templates']
 30
 31# The suffix of source filenames.
 32source_suffix = '.rst'
 33
 34# The encoding of source files.
 35source_encoding = 'utf-8'
 36
 37# The master toctree document.
 38master_doc = 'index'
 39
 40# General information about the project.
 41project = u'Johnny Cache'
 42copyright = u'2010, Jason Moiron, Jeremy Self'
 43
 44# The version info for the project you're documenting, acts as replacement for
 45# |version| and |release|, also used in various other places throughout the
 46# built documents.
 47#
 48# The short X.Y version.
 49version = None
 50for line in open(os.path.join(projpath, 'setup.py'), 'r'):
 51    if line.startswith('version'):
 52        exec line
 53if version is None:
 54    version = '0.1'
 55# The full version, including alpha/beta/rc tags.
 56release = version
 57
 58print ("Building release: %s, version: %s" % (release, version))
 59
 60# The language for content autogenerated by Sphinx. Refer to documentation
 61# for a list of supported languages.
 62#language = None
 63
 64# There are two options for replacing |today|: either, you set today to some
 65# non-false value, then it is used:
 66#today = ''
 67# Else, today_fmt is used as the format for a strftime call.
 68#today_fmt = '%B %d, %Y'
 69
 70# List of documents that shouldn't be included in the build.
 71#unused_docs = []
 72
 73# List of directories, relative to source directory, that shouldn't be searched
 74# for source files.
 75exclude_trees = ['_build']
 76
 77# The reST default role (used for this markup: `text`) to use for all documents.
 78#default_role = None
 79
 80# If true, '()' will be appended to :func: etc. cross-reference text.
 81#add_function_parentheses = True
 82
 83# If true, the current module name will be prepended to all description
 84# unit titles (such as .. function::).
 85#add_module_names = True
 86
 87# If true, sectionauthor and moduleauthor directives will be shown in the
 88# output. They are ignored by default.
 89#show_authors = False
 90
 91# The name of the Pygments (syntax highlighting) style to use.
 92pygments_style = 'sphinx'
 93
 94# A list of ignored prefixes for module index sorting.
 95#modindex_common_prefix = []
 96
 97
 98# -- Options for HTML output ---------------------------------------------------
 99
100# The theme to use for HTML and HTML Help pages.  Major themes that come with
101# Sphinx are currently 'default' and 'sphinxdoc'.
102html_theme = 'nature'
103
104# Theme options are theme-specific and customize the look and feel of a theme
105# further.  For a list of options available for each theme, see the
106# documentation.
107#html_theme_options = {}
108
109# Add any paths that contain custom themes here, relative to this directory.
110html_theme_path = ['_theme']
111
112# The name for this set of Sphinx documents.  If None, it defaults to
113# "<project> v<release> documentation".
114#html_title = None
115
116# A shorter title for the navigation bar.  Default is the same as html_title.
117#html_short_title = None
118
119# The name of an image file (relative to this directory) to place at the top
120# of the sidebar.
121#html_logo = None
122
123# The name of an image file (within the static path) to use as favicon of the
124# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
125# pixels large.
126#html_favicon = None
127
128# Add any paths that contain custom static files (such as style sheets) here,
129# relative to this directory. They are copied after the builtin static files,
130# so a file named "default.css" will overwrite the builtin "default.css".
131html_static_path = ['_static']
132
133# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134# using the given strftime format.
135#html_last_updated_fmt = '%b %d, %Y'
136
137# If true, SmartyPants will be used to convert quotes and dashes to
138# typographically correct entities.
139#html_use_smartypants = True
140
141# Custom sidebar templates, maps document names to template names.
142#html_sidebars = {}
143
144# Additional templates that should be rendered to pages, maps page names to
145# template names.
146#html_additional_pages = {}
147
148# If false, no module index is generated.
149#html_use_modindex = True
150
151# If false, no index is generated.
152#html_use_index = True
153
154# If true, the index is split into individual pages for each letter.
155#html_split_index = False
156
157# If true, links to the reST sources are added to the pages.
158html_show_sourcelink = False
159
160# If true, an OpenSearch description file will be output, and all pages will
161# contain a <link> tag referring to it.  The value of this option must be the
162# base URL from which the finished HTML is served.
163#html_use_opensearch = ''
164
165# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
166#html_file_suffix = ''
167
168# Output file base name for HTML help builder.
169htmlhelp_basename = 'JohnnyCachedoc'
170
171
172# -- Options for LaTeX output --------------------------------------------------
173
174# The paper size ('letter' or 'a4').
175#latex_paper_size = 'letter'
176
177# The font size ('10pt', '11pt' or '12pt').
178#latex_font_size = '10pt'
179
180# Grouping the document tree into LaTeX files. List of tuples
181# (source start file, target name, title, author, documentclass [howto/manual]).
182latex_documents = [
183  ('index', 'JohnnyCache.tex', u'Johnny Cache Documentation',
184   u'Jason Moiron, Jeremy Self', 'manual'),
185]
186
187# The name of an image file (relative to this directory) to place at the top of
188# the title page.
189#latex_logo = None
190
191# For "manual" documents, if this is true, then toplevel headings are parts,
192# not chapters.
193#latex_use_parts = False
194
195# Additional stuff for the LaTeX preamble.
196#latex_preamble = ''
197
198# Documents to append as an appendix to all manuals.
199#latex_appendices = []
200
201# If false, no module index is generated.
202#latex_use_modindex = True