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 # crcmod documentation build configuration file, created by |
8 # sphinx-quickstart on Thu Aug 15 11:31:06 2013. | 4 # sphinx-quickstart on Thu Jan 21 14:04:12 2010. |
9 # | 5 # |
10 # This file is execfile()d with the current directory set to its containing dir. | 6 # This file is execfile()d with the current directory set to its containing dir. |
11 # | 7 # |
12 # Note that not all possible configuration values are present in this | 8 # Note that not all possible configuration values are present in this |
13 # autogenerated file. | 9 # autogenerated file. |
14 # | 10 # |
15 # All configuration values have a default; values that are commented out | 11 # All configuration values have a default; values that are commented out |
16 # serve to show the default. | 12 # serve to show the default. |
17 | 13 |
18 import sys, os | 14 import sys, os |
19 | 15 |
20 # Where we keep our extensions... | 16 # If extensions (or modules to document with autodoc) are in another directory, |
21 sys.path.insert(0, os.path.abspath('_sphinxext')) | 17 # add these directories to sys.path here. If the directory is relative to the |
| 18 # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 19 #sys.path.append(os.path.abspath('.')) |
22 | 20 |
23 # -- General configuration ----------------------------------------------------- | 21 # -- General configuration ----------------------------------------------------- |
24 | 22 |
25 # If your documentation needs a minimal Sphinx version, state it here. | 23 # If your documentation needs a minimal Sphinx version, state it here. |
26 #needs_sphinx = '1.0' | 24 #needs_sphinx = '1.0' |
27 | 25 |
28 # Add any Sphinx extension module names here, as strings. They can be extensions | 26 # Add any Sphinx extension module names here, as strings. They can be extensions |
29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | 27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
30 extensions = ['devsite_builder', 'chromesite_builder'] | 28 extensions = [ 'sphinx.ext.intersphinx', ] |
31 | 29 |
32 # Add any paths that contain templates here, relative to this directory. | 30 # Add any paths that contain templates here, relative to this directory. |
33 templates_path = ['_templates'] | 31 templates_path = ['_templates'] |
34 | 32 |
35 # The suffix of source filenames. | 33 # The suffix of source filenames. |
36 source_suffix = '.rst' | 34 source_suffix = '.rst' |
37 | 35 |
38 # The encoding of source files. | 36 # The encoding of source files. |
39 #source_encoding = 'utf-8-sig' | 37 #source_encoding = 'utf-8-sig' |
40 | 38 |
41 # The master toctree document. | 39 # The master toctree document. |
42 master_doc = 'index' | 40 master_doc = 'index' |
43 | 41 |
44 # General information about the project. | 42 # General information about the project. |
45 project = u'Native Client' | 43 project = u'crcmod' |
| 44 copyright = u'2010, Raymond L Buvel' |
46 | 45 |
47 # The version info for the project you're documenting, acts as replacement for | 46 # 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 | 47 # |version| and |release|, also used in various other places throughout the |
49 # built documents. | 48 # built documents. |
50 # | 49 # |
51 # The short X.Y version. | 50 # The short X.Y version. |
52 version = '31' | 51 version = '1.7' |
53 # The full version, including alpha/beta/rc tags. | 52 # The full version, including alpha/beta/rc tags. |
54 release = '31' | 53 release = '1.7' |
55 | 54 |
56 # The language for content autogenerated by Sphinx. Refer to documentation | 55 # The language for content autogenerated by Sphinx. Refer to documentation |
57 # for a list of supported languages. | 56 # for a list of supported languages. |
58 #language = None | 57 #language = None |
59 | 58 |
60 # There are two options for replacing |today|: either, you set today to some | 59 # There are two options for replacing |today|: either, you set today to some |
61 # non-false value, then it is used: | 60 # non-false value, then it is used: |
62 #today = '' | 61 #today = '' |
63 # Else, today_fmt is used as the format for a strftime call. | 62 # Else, today_fmt is used as the format for a strftime call. |
64 #today_fmt = '%B %d, %Y' | 63 #today_fmt = '%B %d, %Y' |
65 | 64 |
66 # List of patterns, relative to source directory, that match files and | 65 # List of patterns, relative to source directory, that match files and |
67 # directories to ignore when looking for source files. | 66 # directories to ignore when looking for source files. |
68 exclude_patterns = ['_build', '**/.#*'] | 67 exclude_patterns = ['_build'] |
69 | 68 |
70 # The reST default role (used for this markup: `text`) to use for all documents. | 69 # The reST default role (used for this markup: `text`) to use for all documents. |
71 #default_role = None | 70 #default_role = None |
72 | 71 |
73 # If true, '()' will be appended to :func: etc. cross-reference text. | 72 # If true, '()' will be appended to :func: etc. cross-reference text. |
74 #add_function_parentheses = True | 73 #add_function_parentheses = True |
75 | 74 |
76 # If true, the current module name will be prepended to all description | 75 # If true, the current module name will be prepended to all description |
77 # unit titles (such as .. function::). | 76 # unit titles (such as .. function::). |
78 #add_module_names = True | 77 #add_module_names = True |
79 | 78 |
80 # If true, sectionauthor and moduleauthor directives will be shown in the | 79 # If true, sectionauthor and moduleauthor directives will be shown in the |
81 # output. They are ignored by default. | 80 # output. They are ignored by default. |
82 #show_authors = False | 81 #show_authors = False |
83 | 82 |
| 83 # The name of the Pygments (syntax highlighting) style to use. |
| 84 pygments_style = 'sphinx' |
| 85 |
84 # A list of ignored prefixes for module index sorting. | 86 # A list of ignored prefixes for module index sorting. |
85 #modindex_common_prefix = [] | 87 #modindex_common_prefix = [] |
86 | 88 |
87 # If true, keep warnings as "system message" paragraphs in the built documents. | |
88 #keep_warnings = False | |
89 | |
90 | 89 |
91 # -- Options for HTML output --------------------------------------------------- | 90 # -- Options for HTML output --------------------------------------------------- |
92 | 91 |
93 # The theme to use for HTML and HTML Help pages. See the documentation for | 92 # The theme to use for HTML and HTML Help pages. Major themes that come with |
94 # a list of builtin themes. | 93 # Sphinx are currently 'default' and 'sphinxdoc'. |
95 html_theme = 'default' | 94 html_theme = 'default' |
96 | 95 |
97 # Theme options are theme-specific and customize the look and feel of a theme | 96 # 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 | 97 # further. For a list of options available for each theme, see the |
99 # documentation. | 98 # documentation. |
100 #html_theme_options = {} | 99 #html_theme_options = {} |
101 | 100 |
102 # Add any paths that contain custom themes here, relative to this directory. | 101 # Add any paths that contain custom themes here, relative to this directory. |
103 #html_theme_path = [] | 102 #html_theme_path = [] |
104 | 103 |
(...skipping 17 matching lines...) Expand all Loading... |
122 # relative to this directory. They are copied after the builtin static files, | 121 # 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". | 122 # so a file named "default.css" will overwrite the builtin "default.css". |
124 html_static_path = ['_static'] | 123 html_static_path = ['_static'] |
125 | 124 |
126 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | 125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
127 # using the given strftime format. | 126 # using the given strftime format. |
128 #html_last_updated_fmt = '%b %d, %Y' | 127 #html_last_updated_fmt = '%b %d, %Y' |
129 | 128 |
130 # If true, SmartyPants will be used to convert quotes and dashes to | 129 # If true, SmartyPants will be used to convert quotes and dashes to |
131 # typographically correct entities. | 130 # typographically correct entities. |
132 html_use_smartypants = True | 131 #html_use_smartypants = True |
133 | 132 |
134 # Custom sidebar templates, maps document names to template names. | 133 # Custom sidebar templates, maps document names to template names. |
135 #html_sidebars = {} | 134 #html_sidebars = {} |
136 | 135 |
137 # Additional templates that should be rendered to pages, maps page names to | 136 # Additional templates that should be rendered to pages, maps page names to |
138 # template names. | 137 # template names. |
139 #html_additional_pages = {} | 138 #html_additional_pages = {} |
140 | 139 |
141 # If false, no module index is generated. | 140 # If false, no module index is generated. |
142 #html_domain_indices = True | 141 #html_use_modindex = True |
143 | 142 |
144 # If false, no index is generated. | 143 # If false, no index is generated. |
145 #html_use_index = True | 144 #html_use_index = True |
146 | 145 |
147 # If true, the index is split into individual pages for each letter. | 146 # If true, the index is split into individual pages for each letter. |
148 #html_split_index = False | 147 #html_split_index = False |
149 | 148 |
150 # If true, links to the reST sources are added to the pages. | 149 # If true, links to the reST sources are added to the pages. |
151 #html_show_sourcelink = True | 150 #html_show_sourcelink = True |
152 | 151 |
153 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | 152 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
154 #html_show_sphinx = True | 153 #html_show_sphinx = True |
155 | 154 |
156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | 155 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
157 #html_show_copyright = True | 156 #html_show_copyright = True |
158 | 157 |
159 # If true, an OpenSearch description file will be output, and all pages will | 158 # 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 | 159 # 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. | 160 # base URL from which the finished HTML is served. |
162 #html_use_opensearch = '' | 161 #html_use_opensearch = '' |
163 | 162 |
164 # This is the file name suffix for HTML files (e.g. ".xhtml"). | 163 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
165 #html_file_suffix = None | 164 #html_file_suffix = '' |
166 | 165 |
167 # Output file base name for HTML help builder. | 166 # Output file base name for HTML help builder. |
168 htmlhelp_basename = 'NativeClientdoc' | 167 htmlhelp_basename = 'crcmoddoc' |
169 | 168 |
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 | 169 |
177 # | 170 # -- Options for LaTeX output -------------------------------------------------- |
178 # Specific known bad cases go here. | |
179 # | |
180 | 171 |
181 # linkcheck's anchor checker can't check these because they are | 172 # The paper size ('letter' or 'a4'). |
182 # server-generated and don't actually appear in the HTML of the page. | 173 #latex_paper_size = 'letter' |
183 r'https://code.google.com.*browse#svn.*', | |
184 ] | |
185 | 174 |
| 175 # The font size ('10pt', '11pt' or '12pt'). |
| 176 #latex_font_size = '10pt' |
| 177 |
| 178 # Grouping the document tree into LaTeX files. List of tuples |
| 179 # (source start file, target name, title, author, documentclass [howto/manual]). |
| 180 latex_documents = [ |
| 181 ('index', 'crcmod.tex', u'crcmod Documentation', |
| 182 u'Raymond L Buvel', 'manual'), |
| 183 ] |
| 184 |
| 185 # The name of an image file (relative to this directory) to place at the top of |
| 186 # the title page. |
| 187 #latex_logo = None |
| 188 |
| 189 # For "manual" documents, if this is true, then toplevel headings are parts, |
| 190 # not chapters. |
| 191 #latex_use_parts = False |
| 192 |
| 193 # Additional stuff for the LaTeX preamble. |
| 194 #latex_preamble = '' |
| 195 |
| 196 # Documents to append as an appendix to all manuals. |
| 197 #latex_appendices = [] |
| 198 |
| 199 # If false, no module index is generated. |
| 200 #latex_use_modindex = True |
| 201 |
| 202 |
| 203 # -- Options for Epub output --------------------------------------------------- |
| 204 |
| 205 # Bibliographic Dublin Core info. |
| 206 #epub_title = '' |
| 207 #epub_author = '' |
| 208 #epub_publisher = '' |
| 209 #epub_copyright = '' |
| 210 |
| 211 # The language of the text. It defaults to the language option |
| 212 # or en if the language is not set. |
| 213 #epub_language = '' |
| 214 |
| 215 # The scheme of the identifier. Typical schemes are ISBN or URL. |
| 216 #epub_scheme = '' |
| 217 |
| 218 # The unique identifier of the text. This can be a ISBN number |
| 219 # or the project homepage. |
| 220 #epub_identifier = '' |
| 221 |
| 222 # A unique identification for the text. |
| 223 #epub_uid = '' |
| 224 |
| 225 # HTML files that should be inserted before the pages created by sphinx. |
| 226 # The format is a list of tuples containing the path and title. |
| 227 #epub_pre_files = [] |
| 228 |
| 229 # HTML files shat should be inserted after the pages created by sphinx. |
| 230 # The format is a list of tuples containing the path and title. |
| 231 #epub_post_files = [] |
| 232 |
| 233 # A list of files that should not be packed into the epub file. |
| 234 #epub_exclude_files = [] |
| 235 |
| 236 # -- Options for intersphinx -------------------------------------------------- |
| 237 intersphinx_mapping = {'http://docs.python.org/': None} |
OLD | NEW |