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 os
15import sys
16
17on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
18
19# If your extensions are in another directory, add it here.
20sys.path.insert(0, os.path.abspath(os.pardir))
21
22# General configuration
23# ---------------------
24
25# Add any Sphinx extension module names here, as strings. They can be extensions
26# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27extensions = ['sphinx.ext.autodoc', 'sphinx.ext.extlinks']
28
29# Add any paths that contain templates here, relative to this directory.
30#templates_path = ['_templates']
31
32# The suffix of source filenames.
33source_suffix = '.rst'
34
35# The master toctree document.
36master_doc = 'index'
37
38# General substitutions.
39project = 'virtualenv'
40copyright = '2007-2014, Ian Bicking, The Open Planning Project, PyPA'
41
42# The default replacements for |version| and |release|, also used in various
43# other places throughout the built documents.
44try:
45    from virtualenv import __version__
46    # The short X.Y version.
47    version = '.'.join(__version__.split('.')[:2])
48    # The full version, including alpha/beta/rc tags.
49    release = __version__
50except ImportError:
51    version = release = 'dev'
52
53# There are two options for replacing |today|: either, you set today to some
54# non-false value, then it is used:
55#today = ''
56# Else, today_fmt is used as the format for a strftime call.
57today_fmt = '%B %d, %Y'
58
59# List of documents that shouldn't be included in the build.
60unused_docs = []
61
62# If true, '()' will be appended to :func: etc. cross-reference text.
63#add_function_parentheses = True
64
65# If true, the current module name will be prepended to all description
66# unit titles (such as .. function::).
67#add_module_names = True
68
69# If true, sectionauthor and moduleauthor directives will be shown in the
70# output. They are ignored by default.
71#show_authors = False
72
73# The name of the Pygments (syntax highlighting) style to use.
74pygments_style = 'sphinx'
75
76extlinks = {
77    'issue': ('https://github.com/pypa/virtualenv/issues/%s', '#'),
78    'pull': ('https://github.com/pypa/virtualenv/pull/%s', 'PR #'),
79}
80
81
82# Options for HTML output
83# -----------------------
84
85# The style sheet to use for HTML and HTML Help pages. A file of that name
86# must exist either in Sphinx' static/ path, or in one of the custom paths
87# given in html_static_path.
88#html_style = 'default.css'
89
90html_theme = 'default'
91if not on_rtd:
92    try:
93        import sphinx_rtd_theme
94        html_theme = 'sphinx_rtd_theme'
95        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
96    except ImportError:
97        pass
98
99
100# Add any paths that contain custom static files (such as style sheets) here,
101# relative to this directory. They are copied after the builtin static files,
102# so a file named "default.css" will overwrite the builtin "default.css".
103# html_static_path = ['_static']
104
105# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
106# using the given strftime format.
107html_last_updated_fmt = '%b %d, %Y'
108
109# If true, SmartyPants will be used to convert quotes and dashes to
110# typographically correct entities.
111#html_use_smartypants = True
112
113# Content template for the index page.
114#html_index = ''
115
116# Custom sidebar templates, maps document names to template names.
117#html_sidebars = {}
118
119# Additional templates that should be rendered to pages, maps page names to
120# template names.
121#html_additional_pages = {}
122
123# If false, no module index is generated.
124#html_use_modindex = True
125
126# If true, the reST sources are included in the HTML build as _sources/<name>.
127#html_copy_source = True
128
129# Output file base name for HTML help builder.
130htmlhelp_basename = 'Pastedoc'
131
132
133# Options for LaTeX output
134# ------------------------
135
136# The paper size ('letter' or 'a4').
137#latex_paper_size = 'letter'
138
139# The font size ('10pt', '11pt' or '12pt').
140#latex_font_size = '10pt'
141
142# Grouping the document tree into LaTeX files. List of tuples
143# (source start file, target name, title, author, document class [howto/manual]).
144#latex_documents = []
145
146# Additional stuff for the LaTeX preamble.
147#latex_preamble = ''
148
149# Documents to append as an appendix to all manuals.
150#latex_appendices = []
151
152# If false, no module index is generated.
153#latex_use_modindex = True
154