|
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 if os.environ.get('DOCS_LOCAL'): |
|
87 import sphinx_rtd_theme |
|
88 html_theme = "sphinx_rtd_theme" |
|
89 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
|
90 else: |
|
91 # on RTD |
|
92 html_theme = 'default' |
|
93 |
|
94 |
|
95 # Add any paths that contain custom static files (such as style sheets) here, |
|
96 # relative to this directory. They are copied after the builtin static files, |
|
97 # so a file named "default.css" will overwrite the builtin "default.css". |
|
98 # html_static_path = ['_static'] |
|
99 |
|
100 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
101 # using the given strftime format. |
|
102 html_last_updated_fmt = '%b %d, %Y' |
|
103 |
|
104 # If true, SmartyPants will be used to convert quotes and dashes to |
|
105 # typographically correct entities. |
|
106 #html_use_smartypants = True |
|
107 |
|
108 # Content template for the index page. |
|
109 #html_index = '' |
|
110 |
|
111 # Custom sidebar templates, maps document names to template names. |
|
112 #html_sidebars = {} |
|
113 |
|
114 # Additional templates that should be rendered to pages, maps page names to |
|
115 # template names. |
|
116 #html_additional_pages = {} |
|
117 |
|
118 # If false, no module index is generated. |
|
119 #html_use_modindex = True |
|
120 |
|
121 # If true, the reST sources are included in the HTML build as _sources/<name>. |
|
122 #html_copy_source = True |
|
123 |
|
124 # Output file base name for HTML help builder. |
|
125 htmlhelp_basename = 'Pastedoc' |
|
126 |
|
127 |
|
128 # Options for LaTeX output |
|
129 # ------------------------ |
|
130 |
|
131 # The paper size ('letter' or 'a4'). |
|
132 #latex_paper_size = 'letter' |
|
133 |
|
134 # The font size ('10pt', '11pt' or '12pt'). |
|
135 #latex_font_size = '10pt' |
|
136 |
|
137 # Grouping the document tree into LaTeX files. List of tuples |
|
138 # (source start file, target name, title, author, document class [howto/manual]). |
|
139 #latex_documents = [] |
|
140 |
|
141 # Additional stuff for the LaTeX preamble. |
|
142 #latex_preamble = '' |
|
143 |
|
144 # Documents to append as an appendix to all manuals. |
|
145 #latex_appendices = [] |
|
146 |
|
147 # If false, no module index is generated. |
|
148 #latex_use_modindex = True |