PageRenderTime 174ms CodeModel.GetById 81ms app.highlight 2ms RepoModel.GetById 88ms app.codeStats 0ms

/docs/conf.py

https://bitbucket.org/ianb/silverlining/
Python | 136 lines | 17 code | 36 blank | 83 comment | 0 complexity | f2e577fc97e20c1a81752e2cb9ebc107 MD5 | raw file
  1# -*- coding: utf-8 -*-
  2#
  3# Paste documentation build configuration file, created by
  4# sphinx-quickstart on Tue Apr 22 22:08:49 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 value; values that are commented out
 12# serve to show the default value.
 13
 14import sys
 15
 16# If your extensions are in another directory, add it here.
 17#sys.path.append('some/directory')
 18
 19# General configuration
 20# ---------------------
 21
 22# Add any Sphinx extension module names here, as strings. They can be extensions
 23# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 24extensions = ['sphinx.ext.autodoc']
 25
 26# Add any paths that contain templates here, relative to this directory.
 27templates_path = ['_templates']
 28
 29# The suffix of source filenames.
 30source_suffix = '.txt'
 31
 32# The master toctree document.
 33master_doc = 'index'
 34
 35# General substitutions.
 36project = 'Silver Lining'
 37copyright = '2010, Ian Bicking'
 38
 39# The default replacements for |version| and |release|, also used in various
 40# other places throughout the built documents.
 41#
 42# The short X.Y version.
 43version = '0.0'
 44# The full version, including alpha/beta/rc tags.
 45release = '0.0'
 46
 47# There are two options for replacing |today|: either, you set today to some
 48# non-false value, then it is used:
 49#today = ''
 50# Else, today_fmt is used as the format for a strftime call.
 51today_fmt = '%B %d, %Y'
 52
 53# List of documents that shouldn't be included in the build.
 54unused_docs = []
 55
 56# If true, '()' will be appended to :func: etc. cross-reference text.
 57#add_function_parentheses = True
 58
 59# If true, the current module name will be prepended to all description
 60# unit titles (such as .. function::).
 61#add_module_names = True
 62
 63# If true, sectionauthor and moduleauthor directives will be shown in the
 64# output. They are ignored by default.
 65#show_authors = False
 66
 67# The name of the Pygments (syntax highlighting) style to use.
 68pygments_style = 'sphinx'
 69
 70
 71# Options for HTML output
 72# -----------------------
 73
 74html_theme = 'nature'
 75html_theme_path = ['_theme']
 76#html_favicon = 'favicon.ico'
 77
 78# The style sheet to use for HTML and HTML Help pages. A file of that name
 79# must exist either in Sphinx' static/ path, or in one of the custom paths
 80# given in html_static_path.
 81#html_style = 'default.css'
 82
 83# Add any paths that contain custom static files (such as style sheets) here,
 84# relative to this directory. They are copied after the builtin static files,
 85# so a file named "default.css" will overwrite the builtin "default.css".
 86html_static_path = ['_static']
 87
 88# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 89# using the given strftime format.
 90html_last_updated_fmt = '%b %d, %Y'
 91
 92# If true, SmartyPants will be used to convert quotes and dashes to
 93# typographically correct entities.
 94#html_use_smartypants = True
 95
 96# Content template for the index page.
 97#html_index = ''
 98
 99# Custom sidebar templates, maps document names to template names.
100#html_sidebars = {}
101
102# Additional templates that should be rendered to pages, maps page names to
103# template names.
104#html_additional_pages = {}
105
106# If false, no module index is generated.
107#html_use_modindex = True
108
109# If true, the reST sources are included in the HTML build as _sources/<name>.
110#html_copy_source = True
111
112# Output file base name for HTML help builder.
113htmlhelp_basename = 'silverliningdoc'
114
115
116# Options for LaTeX output
117# ------------------------
118
119# The paper size ('letter' or 'a4').
120#latex_paper_size = 'letter'
121
122# The font size ('10pt', '11pt' or '12pt').
123#latex_font_size = '10pt'
124
125# Grouping the document tree into LaTeX files. List of tuples
126# (source start file, target name, title, author, document class [howto/manual]).
127#latex_documents = []
128
129# Additional stuff for the LaTeX preamble.
130#latex_preamble = ''
131
132# Documents to append as an appendix to all manuals.
133#latex_appendices = []
134
135# If false, no module index is generated.
136#latex_use_modindex = True