1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/python/virtualenv/docs/conf.py Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,148 @@
1.4 +# -*- coding: utf-8 -*-
1.5 +#
1.6 +# Paste documentation build configuration file, created by
1.7 +# sphinx-quickstart on Tue Apr 22 22:08:49 2008.
1.8 +#
1.9 +# This file is execfile()d with the current directory set to its containing dir.
1.10 +#
1.11 +# The contents of this file are pickled, so don't put values in the namespace
1.12 +# that aren't pickleable (module imports are okay, they're removed automatically).
1.13 +#
1.14 +# All configuration values have a default value; values that are commented out
1.15 +# serve to show the default value.
1.16 +
1.17 +import os
1.18 +import sys
1.19 +
1.20 +on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
1.21 +
1.22 +# If your extensions are in another directory, add it here.
1.23 +sys.path.insert(0, os.path.abspath(os.pardir))
1.24 +
1.25 +# General configuration
1.26 +# ---------------------
1.27 +
1.28 +# Add any Sphinx extension module names here, as strings. They can be extensions
1.29 +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
1.30 +extensions = ['sphinx.ext.autodoc']
1.31 +
1.32 +# Add any paths that contain templates here, relative to this directory.
1.33 +## FIXME: disabled for now because I haven't figured out how to use this:
1.34 +#templates_path = ['_templates']
1.35 +
1.36 +# The suffix of source filenames.
1.37 +source_suffix = '.rst'
1.38 +
1.39 +# The master toctree document.
1.40 +master_doc = 'index'
1.41 +
1.42 +# General substitutions.
1.43 +project = 'virtualenv'
1.44 +copyright = '2007-2014, Ian Bicking, The Open Planning Project, PyPA'
1.45 +
1.46 +# The default replacements for |version| and |release|, also used in various
1.47 +# other places throughout the built documents.
1.48 +try:
1.49 + from virtualenv import __version__
1.50 + # The short X.Y version.
1.51 + version = '.'.join(__version__.split('.')[:2])
1.52 + # The full version, including alpha/beta/rc tags.
1.53 + release = __version__
1.54 +except ImportError:
1.55 + version = release = 'dev'
1.56 +
1.57 +# There are two options for replacing |today|: either, you set today to some
1.58 +# non-false value, then it is used:
1.59 +#today = ''
1.60 +# Else, today_fmt is used as the format for a strftime call.
1.61 +today_fmt = '%B %d, %Y'
1.62 +
1.63 +# List of documents that shouldn't be included in the build.
1.64 +unused_docs = []
1.65 +
1.66 +# If true, '()' will be appended to :func: etc. cross-reference text.
1.67 +#add_function_parentheses = True
1.68 +
1.69 +# If true, the current module name will be prepended to all description
1.70 +# unit titles (such as .. function::).
1.71 +#add_module_names = True
1.72 +
1.73 +# If true, sectionauthor and moduleauthor directives will be shown in the
1.74 +# output. They are ignored by default.
1.75 +#show_authors = False
1.76 +
1.77 +# The name of the Pygments (syntax highlighting) style to use.
1.78 +pygments_style = 'sphinx'
1.79 +
1.80 +
1.81 +# Options for HTML output
1.82 +# -----------------------
1.83 +
1.84 +# The style sheet to use for HTML and HTML Help pages. A file of that name
1.85 +# must exist either in Sphinx' static/ path, or in one of the custom paths
1.86 +# given in html_static_path.
1.87 +#html_style = 'default.css'
1.88 +
1.89 +if os.environ.get('DOCS_LOCAL'):
1.90 + import sphinx_rtd_theme
1.91 + html_theme = "sphinx_rtd_theme"
1.92 + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
1.93 +else:
1.94 + # on RTD
1.95 + html_theme = 'default'
1.96 +
1.97 +
1.98 +# Add any paths that contain custom static files (such as style sheets) here,
1.99 +# relative to this directory. They are copied after the builtin static files,
1.100 +# so a file named "default.css" will overwrite the builtin "default.css".
1.101 +# html_static_path = ['_static']
1.102 +
1.103 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
1.104 +# using the given strftime format.
1.105 +html_last_updated_fmt = '%b %d, %Y'
1.106 +
1.107 +# If true, SmartyPants will be used to convert quotes and dashes to
1.108 +# typographically correct entities.
1.109 +#html_use_smartypants = True
1.110 +
1.111 +# Content template for the index page.
1.112 +#html_index = ''
1.113 +
1.114 +# Custom sidebar templates, maps document names to template names.
1.115 +#html_sidebars = {}
1.116 +
1.117 +# Additional templates that should be rendered to pages, maps page names to
1.118 +# template names.
1.119 +#html_additional_pages = {}
1.120 +
1.121 +# If false, no module index is generated.
1.122 +#html_use_modindex = True
1.123 +
1.124 +# If true, the reST sources are included in the HTML build as _sources/<name>.
1.125 +#html_copy_source = True
1.126 +
1.127 +# Output file base name for HTML help builder.
1.128 +htmlhelp_basename = 'Pastedoc'
1.129 +
1.130 +
1.131 +# Options for LaTeX output
1.132 +# ------------------------
1.133 +
1.134 +# The paper size ('letter' or 'a4').
1.135 +#latex_paper_size = 'letter'
1.136 +
1.137 +# The font size ('10pt', '11pt' or '12pt').
1.138 +#latex_font_size = '10pt'
1.139 +
1.140 +# Grouping the document tree into LaTeX files. List of tuples
1.141 +# (source start file, target name, title, author, document class [howto/manual]).
1.142 +#latex_documents = []
1.143 +
1.144 +# Additional stuff for the LaTeX preamble.
1.145 +#latex_preamble = ''
1.146 +
1.147 +# Documents to append as an appendix to all manuals.
1.148 +#latex_appendices = []
1.149 +
1.150 +# If false, no module index is generated.
1.151 +#latex_use_modindex = True
