OLD | NEW |
1 # Copyright (c) 2014 The Chromium Authors. All rights reserved. | |
2 # Use of this source code is governed by a BSD-style license that can be | |
3 # found in the LICENSE file. | |
4 | |
5 # -*- coding: utf-8 -*- | 1 # -*- coding: utf-8 -*- |
6 # | 2 # |
7 # Native Client documentation build configuration file, created by | 3 # six documentation build configuration file |
8 # sphinx-quickstart on Thu Aug 15 11:31:06 2013. | |
9 # | |
10 # This file is execfile()d with the current directory set to its containing dir. | |
11 # | |
12 # Note that not all possible configuration values are present in this | |
13 # autogenerated file. | |
14 # | |
15 # All configuration values have a default; values that are commented out | |
16 # serve to show the default. | |
17 | 4 |
18 import sys, os | 5 import os |
| 6 import sys |
19 | 7 |
20 # Where we keep our extensions... | 8 # If extensions (or modules to document with autodoc) are in another directory, |
21 sys.path.insert(0, os.path.abspath('_sphinxext')) | 9 # add these directories to sys.path here. If the directory is relative to the |
| 10 # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 11 #sys.path.append(os.path.abspath('.')) |
22 | 12 |
23 # -- General configuration ----------------------------------------------------- | 13 # -- General configuration ----------------------------------------------------- |
24 | 14 |
25 # If your documentation needs a minimal Sphinx version, state it here. | 15 # If your documentation needs a minimal Sphinx version, state it here. |
26 #needs_sphinx = '1.0' | 16 needs_sphinx = "1.0" |
27 | 17 |
28 # Add any Sphinx extension module names here, as strings. They can be extensions | 18 # Add any Sphinx extension module names here, as strings. They can be extensions |
29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | 19 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
30 extensions = ['devsite_builder', 'chromesite_builder'] | 20 extensions = ["sphinx.ext.intersphinx"] |
31 | 21 |
32 # Add any paths that contain templates here, relative to this directory. | 22 # Add any paths that contain templates here, relative to this directory. |
33 templates_path = ['_templates'] | 23 templates_path = ["_templates"] |
34 | 24 |
35 # The suffix of source filenames. | 25 # The suffix of source filenames. |
36 source_suffix = '.rst' | 26 source_suffix = ".rst" |
37 | 27 |
38 # The encoding of source files. | 28 # The encoding of source files. |
39 #source_encoding = 'utf-8-sig' | 29 #source_encoding = "utf-8-sig" |
40 | 30 |
41 # The master toctree document. | 31 # The master toctree document. |
42 master_doc = 'index' | 32 master_doc = "index" |
43 | 33 |
44 # General information about the project. | 34 # General information about the project. |
45 project = u'Native Client' | 35 project = u"six" |
| 36 copyright = u"2010-2014, Benjamin Peterson" |
| 37 |
| 38 sys.path.append(os.path.abspath(os.path.join(".", ".."))) |
| 39 from six import __version__ as six_version |
| 40 sys.path.pop() |
46 | 41 |
47 # The version info for the project you're documenting, acts as replacement for | 42 # The version info for the project you're documenting, acts as replacement for |
48 # |version| and |release|, also used in various other places throughout the | 43 # |version| and |release|, also used in various other places throughout the |
49 # built documents. | 44 # built documents. |
50 # | 45 # |
51 # The short X.Y version. | 46 # The short X.Y version. |
52 version = '31' | 47 version = six_version[:-2] |
53 # The full version, including alpha/beta/rc tags. | 48 # The full version, including alpha/beta/rc tags. |
54 release = '31' | 49 release = six_version |
55 | 50 |
56 # The language for content autogenerated by Sphinx. Refer to documentation | 51 # The language for content autogenerated by Sphinx. Refer to documentation |
57 # for a list of supported languages. | 52 # for a list of supported languages. |
58 #language = None | 53 #language = None |
59 | 54 |
60 # There are two options for replacing |today|: either, you set today to some | 55 # There are two options for replacing |today|: either, you set today to some |
61 # non-false value, then it is used: | 56 # non-false value, then it is used: |
62 #today = '' | 57 #today = '' |
63 # Else, today_fmt is used as the format for a strftime call. | 58 # Else, today_fmt is used as the format for a strftime call. |
64 #today_fmt = '%B %d, %Y' | 59 #today_fmt = '%B %d, %Y' |
65 | 60 |
66 # List of patterns, relative to source directory, that match files and | 61 # List of patterns, relative to source directory, that match files and |
67 # directories to ignore when looking for source files. | 62 # directories to ignore when looking for source files. |
68 exclude_patterns = ['_build', '**/.#*'] | 63 exclude_patterns = ["_build"] |
69 | 64 |
70 # The reST default role (used for this markup: `text`) to use for all documents. | 65 # The reST default role (used for this markup: `text`) to use for all documents. |
71 #default_role = None | 66 #default_role = None |
72 | 67 |
73 # If true, '()' will be appended to :func: etc. cross-reference text. | 68 # If true, '()' will be appended to :func: etc. cross-reference text. |
74 #add_function_parentheses = True | 69 #add_function_parentheses = True |
75 | 70 |
76 # If true, the current module name will be prepended to all description | 71 # If true, the current module name will be prepended to all description |
77 # unit titles (such as .. function::). | 72 # unit titles (such as .. function::). |
78 #add_module_names = True | 73 #add_module_names = True |
79 | 74 |
80 # If true, sectionauthor and moduleauthor directives will be shown in the | 75 # If true, sectionauthor and moduleauthor directives will be shown in the |
81 # output. They are ignored by default. | 76 # output. They are ignored by default. |
82 #show_authors = False | 77 #show_authors = False |
83 | 78 |
| 79 # The name of the Pygments (syntax highlighting) style to use. |
| 80 pygments_style = "sphinx" |
| 81 |
84 # A list of ignored prefixes for module index sorting. | 82 # A list of ignored prefixes for module index sorting. |
85 #modindex_common_prefix = [] | 83 #modindex_common_prefix = [] |
86 | 84 |
87 # If true, keep warnings as "system message" paragraphs in the built documents. | |
88 #keep_warnings = False | |
89 | |
90 | 85 |
91 # -- Options for HTML output --------------------------------------------------- | 86 # -- Options for HTML output --------------------------------------------------- |
92 | 87 |
93 # The theme to use for HTML and HTML Help pages. See the documentation for | 88 # The theme to use for HTML and HTML Help pages. See the documentation for |
94 # a list of builtin themes. | 89 # a list of builtin themes. |
95 html_theme = 'default' | 90 html_theme = "default" |
96 | 91 |
97 # Theme options are theme-specific and customize the look and feel of a theme | 92 # Theme options are theme-specific and customize the look and feel of a theme |
98 # further. For a list of options available for each theme, see the | 93 # further. For a list of options available for each theme, see the |
99 # documentation. | 94 # documentation. |
100 #html_theme_options = {} | 95 #html_theme_options = {} |
101 | 96 |
102 # Add any paths that contain custom themes here, relative to this directory. | 97 # Add any paths that contain custom themes here, relative to this directory. |
103 #html_theme_path = [] | 98 #html_theme_path = [] |
104 | 99 |
105 # The name for this set of Sphinx documents. If None, it defaults to | 100 # The name for this set of Sphinx documents. If None, it defaults to |
106 # "<project> v<release> documentation". | 101 # "<project> v<release> documentation". |
107 #html_title = None | 102 #html_title = None |
108 | 103 |
109 # A shorter title for the navigation bar. Default is the same as html_title. | 104 # A shorter title for the navigation bar. Default is the same as html_title. |
110 #html_short_title = None | 105 #html_short_title = None |
111 | 106 |
112 # The name of an image file (relative to this directory) to place at the top | 107 # The name of an image file (relative to this directory) to place at the top |
113 # of the sidebar. | 108 # of the sidebar. |
114 #html_logo = None | 109 #html_logo = None |
115 | 110 |
116 # The name of an image file (within the static path) to use as favicon of the | 111 # The name of an image file (within the static path) to use as favicon of the |
117 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | 112 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
118 # pixels large. | 113 # pixels large. |
119 #html_favicon = None | 114 #html_favicon = None |
120 | 115 |
121 # Add any paths that contain custom static files (such as style sheets) here, | 116 # Add any paths that contain custom static files (such as style sheets) here, |
122 # relative to this directory. They are copied after the builtin static files, | 117 # relative to this directory. They are copied after the builtin static files, |
123 # so a file named "default.css" will overwrite the builtin "default.css". | 118 # so a file named "default.css" will overwrite the builtin "default.css". |
124 html_static_path = ['_static'] | 119 html_static_path = ["_static"] |
125 | 120 |
126 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | 121 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
127 # using the given strftime format. | 122 # using the given strftime format. |
128 #html_last_updated_fmt = '%b %d, %Y' | 123 #html_last_updated_fmt = '%b %d, %Y' |
129 | 124 |
130 # If true, SmartyPants will be used to convert quotes and dashes to | 125 # If true, SmartyPants will be used to convert quotes and dashes to |
131 # typographically correct entities. | 126 # typographically correct entities. |
132 html_use_smartypants = True | 127 #html_use_smartypants = True |
133 | 128 |
134 # Custom sidebar templates, maps document names to template names. | 129 # Custom sidebar templates, maps document names to template names. |
135 #html_sidebars = {} | 130 #html_sidebars = {} |
136 | 131 |
137 # Additional templates that should be rendered to pages, maps page names to | 132 # Additional templates that should be rendered to pages, maps page names to |
138 # template names. | 133 # template names. |
139 #html_additional_pages = {} | 134 #html_additional_pages = {} |
140 | 135 |
141 # If false, no module index is generated. | 136 # If false, no module index is generated. |
142 #html_domain_indices = True | 137 #html_domain_indices = True |
(...skipping 11 matching lines...) Expand all Loading... |
154 #html_show_sphinx = True | 149 #html_show_sphinx = True |
155 | 150 |
156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | 151 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
157 #html_show_copyright = True | 152 #html_show_copyright = True |
158 | 153 |
159 # If true, an OpenSearch description file will be output, and all pages will | 154 # If true, an OpenSearch description file will be output, and all pages will |
160 # contain a <link> tag referring to it. The value of this option must be the | 155 # contain a <link> tag referring to it. The value of this option must be the |
161 # base URL from which the finished HTML is served. | 156 # base URL from which the finished HTML is served. |
162 #html_use_opensearch = '' | 157 #html_use_opensearch = '' |
163 | 158 |
164 # This is the file name suffix for HTML files (e.g. ".xhtml"). | 159 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
165 #html_file_suffix = None | 160 #html_file_suffix = '' |
166 | 161 |
167 # Output file base name for HTML help builder. | 162 # Output file base name for HTML help builder. |
168 htmlhelp_basename = 'NativeClientdoc' | 163 htmlhelp_basename = 'sixdoc' |
169 | 164 |
170 linkcheck_ignore = [ | |
171 # General links not worth checking | |
172 r'http://localhost.*', | |
173 r'about:.*', | |
174 r'chrome:.*', | |
175 r'.*local_extensions\.css', | |
176 | 165 |
177 # | 166 # -- Options for LaTeX output -------------------------------------------------- |
178 # Specific known bad cases go here. | |
179 # | |
180 | 167 |
181 # linkcheck's anchor checker can't check these because they are | 168 # The paper size ('letter' or 'a4'). |
182 # server-generated and don't actually appear in the HTML of the page. | 169 #latex_paper_size = 'letter' |
183 r'https://code.google.com.*browse#svn.*', | |
184 ] | |
185 | 170 |
| 171 # The font size ('10pt', '11pt' or '12pt'). |
| 172 #latex_font_size = '10pt' |
| 173 |
| 174 # Grouping the document tree into LaTeX files. List of tuples |
| 175 # (source start file, target name, title, author, documentclass [howto/manual]). |
| 176 latex_documents = [ |
| 177 ("index", "six.tex", u"six Documentation", |
| 178 u"Benjamin Peterson", "manual"), |
| 179 ] |
| 180 |
| 181 # The name of an image file (relative to this directory) to place at the top of |
| 182 # the title page. |
| 183 #latex_logo = None |
| 184 |
| 185 # For "manual" documents, if this is true, then toplevel headings are parts, |
| 186 # not chapters. |
| 187 #latex_use_parts = False |
| 188 |
| 189 # If true, show page references after internal links. |
| 190 #latex_show_pagerefs = False |
| 191 |
| 192 # If true, show URL addresses after external links. |
| 193 #latex_show_urls = False |
| 194 |
| 195 # Additional stuff for the LaTeX preamble. |
| 196 #latex_preamble = '' |
| 197 |
| 198 # Documents to append as an appendix to all manuals. |
| 199 #latex_appendices = [] |
| 200 |
| 201 # If false, no module index is generated. |
| 202 #latex_domain_indices = True |
| 203 |
| 204 |
| 205 # -- Options for manual page output -------------------------------------------- |
| 206 |
| 207 # One entry per manual page. List of tuples |
| 208 # (source start file, name, description, authors, manual section). |
| 209 man_pages = [ |
| 210 ("index", "six", u"six Documentation", |
| 211 [u"Benjamin Peterson"], 1) |
| 212 ] |
| 213 |
| 214 # -- Intersphinx --------------------------------------------------------------- |
| 215 |
| 216 intersphinx_mapping = {"py2" : ("http://docs.python.org/2/", None), |
| 217 "py3" : ("http://docs.python.org/3/", None)} |
OLD | NEW |