michael@0: # -*- coding: utf-8 -*- michael@0: # michael@0: # Paste documentation build configuration file, created by michael@0: # sphinx-quickstart on Tue Apr 22 22:08:49 2008. michael@0: # michael@0: # This file is execfile()d with the current directory set to its containing dir. michael@0: # michael@0: # The contents of this file are pickled, so don't put values in the namespace michael@0: # that aren't pickleable (module imports are okay, they're removed automatically). michael@0: # michael@0: # All configuration values have a default value; values that are commented out michael@0: # serve to show the default value. michael@0: michael@0: import os michael@0: import sys michael@0: michael@0: on_rtd = os.environ.get('READTHEDOCS', None) == 'True' michael@0: michael@0: # If your extensions are in another directory, add it here. michael@0: sys.path.insert(0, os.path.abspath(os.pardir)) michael@0: michael@0: # General configuration michael@0: # --------------------- michael@0: michael@0: # Add any Sphinx extension module names here, as strings. They can be extensions michael@0: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. michael@0: extensions = ['sphinx.ext.autodoc'] michael@0: michael@0: # Add any paths that contain templates here, relative to this directory. michael@0: ## FIXME: disabled for now because I haven't figured out how to use this: michael@0: #templates_path = ['_templates'] michael@0: michael@0: # The suffix of source filenames. michael@0: source_suffix = '.rst' michael@0: michael@0: # The master toctree document. michael@0: master_doc = 'index' michael@0: michael@0: # General substitutions. michael@0: project = 'virtualenv' michael@0: copyright = '2007-2014, Ian Bicking, The Open Planning Project, PyPA' michael@0: michael@0: # The default replacements for |version| and |release|, also used in various michael@0: # other places throughout the built documents. michael@0: try: michael@0: from virtualenv import __version__ michael@0: # The short X.Y version. michael@0: version = '.'.join(__version__.split('.')[:2]) michael@0: # The full version, including alpha/beta/rc tags. michael@0: release = __version__ michael@0: except ImportError: michael@0: version = release = 'dev' michael@0: michael@0: # There are two options for replacing |today|: either, you set today to some michael@0: # non-false value, then it is used: michael@0: #today = '' michael@0: # Else, today_fmt is used as the format for a strftime call. michael@0: today_fmt = '%B %d, %Y' michael@0: michael@0: # List of documents that shouldn't be included in the build. michael@0: unused_docs = [] michael@0: michael@0: # If true, '()' will be appended to :func: etc. cross-reference text. michael@0: #add_function_parentheses = True michael@0: michael@0: # If true, the current module name will be prepended to all description michael@0: # unit titles (such as .. function::). michael@0: #add_module_names = True michael@0: michael@0: # If true, sectionauthor and moduleauthor directives will be shown in the michael@0: # output. They are ignored by default. michael@0: #show_authors = False michael@0: michael@0: # The name of the Pygments (syntax highlighting) style to use. michael@0: pygments_style = 'sphinx' michael@0: michael@0: michael@0: # Options for HTML output michael@0: # ----------------------- michael@0: michael@0: # The style sheet to use for HTML and HTML Help pages. A file of that name michael@0: # must exist either in Sphinx' static/ path, or in one of the custom paths michael@0: # given in html_static_path. michael@0: #html_style = 'default.css' michael@0: michael@0: if os.environ.get('DOCS_LOCAL'): michael@0: import sphinx_rtd_theme michael@0: html_theme = "sphinx_rtd_theme" michael@0: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] michael@0: else: michael@0: # on RTD michael@0: html_theme = 'default' michael@0: michael@0: michael@0: # Add any paths that contain custom static files (such as style sheets) here, michael@0: # relative to this directory. They are copied after the builtin static files, michael@0: # so a file named "default.css" will overwrite the builtin "default.css". michael@0: # html_static_path = ['_static'] michael@0: michael@0: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, michael@0: # using the given strftime format. michael@0: html_last_updated_fmt = '%b %d, %Y' michael@0: michael@0: # If true, SmartyPants will be used to convert quotes and dashes to michael@0: # typographically correct entities. michael@0: #html_use_smartypants = True michael@0: michael@0: # Content template for the index page. michael@0: #html_index = '' michael@0: michael@0: # Custom sidebar templates, maps document names to template names. michael@0: #html_sidebars = {} michael@0: michael@0: # Additional templates that should be rendered to pages, maps page names to michael@0: # template names. michael@0: #html_additional_pages = {} michael@0: michael@0: # If false, no module index is generated. michael@0: #html_use_modindex = True michael@0: michael@0: # If true, the reST sources are included in the HTML build as _sources/. michael@0: #html_copy_source = True michael@0: michael@0: # Output file base name for HTML help builder. michael@0: htmlhelp_basename = 'Pastedoc' michael@0: michael@0: michael@0: # Options for LaTeX output michael@0: # ------------------------ michael@0: michael@0: # The paper size ('letter' or 'a4'). michael@0: #latex_paper_size = 'letter' michael@0: michael@0: # The font size ('10pt', '11pt' or '12pt'). michael@0: #latex_font_size = '10pt' michael@0: michael@0: # Grouping the document tree into LaTeX files. List of tuples michael@0: # (source start file, target name, title, author, document class [howto/manual]). michael@0: #latex_documents = [] michael@0: michael@0: # Additional stuff for the LaTeX preamble. michael@0: #latex_preamble = '' michael@0: michael@0: # Documents to append as an appendix to all manuals. michael@0: #latex_appendices = [] michael@0: michael@0: # If false, no module index is generated. michael@0: #latex_use_modindex = True