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