1
# -*- coding: utf-8 -*-
3
# virtualenvwrapper documentation build configuration file, created by
4
# sphinx-quickstart on Thu May 28 22:35:13 2009.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
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.
19
#sys.path.append(os.path.abspath('.'))
21
# -- General configuration -----------------------------------------------------
23
# Add any Sphinx extension module names here, as strings. They can be extensions
24
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25
extensions = [ 'sphinxcontrib.bitbucket' ]
27
bitbucket_project_url = 'http://bitbucket.org/dhellmann/virtualenvwrapper/'
29
# Add any paths that contain templates here, relative to this directory.
30
#templates_path = ['pkg/templates']
32
# The suffix of source filenames.
33
source_suffix = '.rst'
35
# The encoding of source files.
36
#source_encoding = 'utf-8'
38
# The master toctree document.
41
# General information about the project.
42
project = u'virtualenvwrapper'
43
copyright = u'2009-2011, Doug Hellmann'
45
# The version info for the project you're documenting, acts as replacement for
46
# |version| and |release|, also used in various other places throughout the
49
# The short X.Y version.
51
# The full version, including alpha/beta/rc tags.
54
# The language for content autogenerated by Sphinx. Refer to documentation
55
# for a list of supported languages.
58
# There are two options for replacing |today|: either, you set today to some
59
# non-false value, then it is used:
61
# Else, today_fmt is used as the format for a strftime call.
62
#today_fmt = '%B %d, %Y'
64
# List of documents that shouldn't be included in the build.
67
# List of directories, relative to source directory, that shouldn't be searched
69
exclude_trees = ['_build']
71
# The reST default role (used for this markup: `text`) to use for all documents.
74
# If true, '()' will be appended to :func: etc. cross-reference text.
75
#add_function_parentheses = True
77
# If true, the current module name will be prepended to all description
78
# unit titles (such as .. function::).
79
#add_module_names = True
81
# If true, sectionauthor and moduleauthor directives will be shown in the
82
# output. They are ignored by default.
85
# The name of the Pygments (syntax highlighting) style to use.
86
pygments_style = 'sphinx'
88
# A list of ignored prefixes for module index sorting.
89
#modindex_common_prefix = []
92
# -- Options for HTML output ---------------------------------------------------
94
# The theme to use for HTML and HTML Help pages. Major themes that come with
95
# Sphinx are currently 'default' and 'sphinxdoc'.
98
# Theme options are theme-specific and customize the look and feel of a theme
99
# further. For a list of options available for each theme, see the
101
#html_theme_options = {}
103
# Add any paths that contain custom themes here, relative to this directory.
104
#html_theme_path = []
106
# The name for this set of Sphinx documents. If None, it defaults to
107
# "<project> v<release> documentation".
110
# A shorter title for the navigation bar. Default is the same as html_title.
111
#html_short_title = None
113
# The name of an image file (relative to this directory) to place at the top
117
# The name of an image file (within the static path) to use as favicon of the
118
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
122
# Add any paths that contain custom static files (such as style sheets) here,
123
# relative to this directory. They are copied after the builtin static files,
124
# so a file named "default.css" will overwrite the builtin "default.css".
125
#html_static_path = ['static']
127
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128
# using the given strftime format.
129
#html_last_updated_fmt = '%b %d, %Y'
131
# If true, SmartyPants will be used to convert quotes and dashes to
132
# typographically correct entities.
133
#html_use_smartypants = True
135
# Custom sidebar templates, maps document names to template names.
138
# Additional templates that should be rendered to pages, maps page names to
140
#html_additional_pages = {}
142
# If false, no module index is generated.
143
html_use_modindex = False
145
# If false, no index is generated.
146
html_use_index = False
148
# If true, the index is split into individual pages for each letter.
149
#html_split_index = False
151
# If true, links to the reST sources are added to the pages.
152
#html_show_sourcelink = True
154
# If true, an OpenSearch description file will be output, and all pages will
155
# contain a <link> tag referring to it. The value of this option must be the
156
# base URL from which the finished HTML is served.
157
#html_use_opensearch = ''
159
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
160
#html_file_suffix = ''
162
# Output file base name for HTML help builder.
163
htmlhelp_basename = 'virtualenvwrapperdoc'
166
# -- Options for LaTeX output --------------------------------------------------
168
# The paper size ('letter' or 'a4').
169
#latex_paper_size = 'letter'
171
# The font size ('10pt', '11pt' or '12pt').
172
#latex_font_size = '10pt'
174
# Grouping the document tree into LaTeX files. List of tuples
175
# (source start file, target name, title, author, documentclass [howto/manual]).
177
('index', 'virtualenvwrapper.tex', u'virtualenvwrapper Documentation',
178
u'Doug Hellmann', 'manual'),
181
# The name of an image file (relative to this directory) to place at the top of
185
# For "manual" documents, if this is true, then toplevel headings are parts,
187
#latex_use_parts = False
189
# Additional stuff for the LaTeX preamble.
192
# Documents to append as an appendix to all manuals.
193
#latex_appendices = []
195
# If false, no module index is generated.
196
#latex_use_modindex = True