1
# -*- coding: utf-8 -*-
3
# Paste documentation build configuration file, created by
4
# sphinx-quickstart on Tue Apr 22 22:08:49 2008.
6
# This file is execfile()d with the current directory set to its containing dir.
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).
11
# All configuration values have a default value; values that are commented out
12
# serve to show the default value.
16
# If your extensions are in another directory, add it here.
17
#sys.path.append('some/directory')
19
# General configuration
20
# ---------------------
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.
24
extensions = ['sphinx.ext.autodoc']
26
# Add any paths that contain templates here, relative to this directory.
27
## FIXME: disabled for now because I haven't figured out how to use this:
28
#templates_path = ['_templates']
30
# The suffix of source filenames.
31
source_suffix = '.txt'
33
# The master toctree document.
36
# General substitutions.
37
project = 'virtualenv'
38
copyright = '2007-2012, Ian Bicking, The Open Planning Project, The virtualenv developers'
40
# The default replacements for |version| and |release|, also used in various
41
# other places throughout the built documents.
43
from virtualenv import __version__
44
# The short X.Y version.
45
version = '.'.join(__version__.split('.')[:2])
46
# The full version, including alpha/beta/rc tags.
49
version = release = 'dev'
51
# There are two options for replacing |today|: either, you set today to some
52
# non-false value, then it is used:
54
# Else, today_fmt is used as the format for a strftime call.
55
today_fmt = '%B %d, %Y'
57
# List of documents that shouldn't be included in the build.
60
# If true, '()' will be appended to :func: etc. cross-reference text.
61
#add_function_parentheses = True
63
# If true, the current module name will be prepended to all description
64
# unit titles (such as .. function::).
65
#add_module_names = True
67
# If true, sectionauthor and moduleauthor directives will be shown in the
68
# output. They are ignored by default.
71
# The name of the Pygments (syntax highlighting) style to use.
72
pygments_style = 'sphinx'
75
# Options for HTML output
76
# -----------------------
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'
84
html_theme_path = ['_theme']
86
# Add any paths that contain custom static files (such as style sheets) here,
87
# relative to this directory. They are copied after the builtin static files,
88
# so a file named "default.css" will overwrite the builtin "default.css".
89
# html_static_path = ['_static']
91
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
92
# using the given strftime format.
93
html_last_updated_fmt = '%b %d, %Y'
95
# If true, SmartyPants will be used to convert quotes and dashes to
96
# typographically correct entities.
97
#html_use_smartypants = True
99
# Content template for the index page.
102
# Custom sidebar templates, maps document names to template names.
105
# Additional templates that should be rendered to pages, maps page names to
107
#html_additional_pages = {}
109
# If false, no module index is generated.
110
#html_use_modindex = True
112
# If true, the reST sources are included in the HTML build as _sources/<name>.
113
#html_copy_source = True
115
# Output file base name for HTML help builder.
116
htmlhelp_basename = 'Pastedoc'
119
# Options for LaTeX output
120
# ------------------------
122
# The paper size ('letter' or 'a4').
123
#latex_paper_size = 'letter'
125
# The font size ('10pt', '11pt' or '12pt').
126
#latex_font_size = '10pt'
128
# Grouping the document tree into LaTeX files. List of tuples
129
# (source start file, target name, title, author, document class [howto/manual]).
130
#latex_documents = []
132
# Additional stuff for the LaTeX preamble.
135
# Documents to append as an appendix to all manuals.
136
#latex_appendices = []
138
# If false, no module index is generated.
139
#latex_use_modindex = True