Show More
@@ -1,165 +1,166 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | # |
|
2 | # | |
3 | # IPython documentation build configuration file, created by |
|
3 | # IPython documentation build configuration file, created by | |
4 | # sphinx-quickstart on Thu May 8 16:45:02 2008. |
|
4 | # sphinx-quickstart on Thu May 8 16:45:02 2008. | |
5 | # |
|
5 | # | |
6 | # 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. | |
7 | # |
|
7 | # | |
8 | # The contents of this file are pickled, so don't put values in the namespace |
|
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). |
|
9 | # that aren't pickleable (module imports are okay, they're removed automatically). | |
10 | # |
|
10 | # | |
11 | # All configuration values have a default value; values that are commented out |
|
11 | # All configuration values have a default value; values that are commented out | |
12 | # serve to show the default value. |
|
12 | # serve to show the default value. | |
13 |
|
13 | |||
14 | import sys, os |
|
14 | import sys, os | |
15 |
|
15 | |||
16 | # If your extensions are in another directory, add it here. If the directory |
|
16 | # If your extensions are in another directory, add it here. If the directory | |
17 | # is relative to the documentation root, use os.path.abspath to make it |
|
17 | # is relative to the documentation root, use os.path.abspath to make it | |
18 | # absolute, like shown here. |
|
18 | # absolute, like shown here. | |
19 | #sys.path.append(os.path.abspath('some/directory')) |
|
19 | #sys.path.append(os.path.abspath('some/directory')) | |
20 |
|
20 | |||
21 | # General configuration |
|
21 | # General configuration | |
22 | # --------------------- |
|
22 | # --------------------- | |
23 |
|
23 | |||
24 | # Add any Sphinx extension module names here, as strings. They can be extensions |
|
24 | # Add any Sphinx extension module names here, as strings. They can be extensions | |
25 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
25 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
26 | #extensions = [] |
|
26 | #extensions = [] | |
27 |
|
27 | |||
28 | # Add any paths that contain templates here, relative to this directory. |
|
28 | # Add any paths that contain templates here, relative to this directory. | |
29 | templates_path = ['_templates'] |
|
29 | templates_path = ['_templates'] | |
30 |
|
30 | |||
31 | # The suffix of source filenames. |
|
31 | # The suffix of source filenames. | |
32 | source_suffix = '.txt' |
|
32 | source_suffix = '.txt' | |
33 |
|
33 | |||
34 | # The master toctree document. |
|
34 | # The master toctree document. | |
35 | master_doc = 'index' |
|
35 | master_doc = 'index' | |
36 |
|
36 | |||
37 | # General substitutions. |
|
37 | # General substitutions. | |
38 | project = 'IPython' |
|
38 | project = 'IPython' | |
39 | copyright = '2008, The IPython Development Team' |
|
39 | copyright = '2008, The IPython Development Team' | |
40 |
|
40 | |||
41 | # The default replacements for |version| and |release|, also used in various |
|
41 | # The default replacements for |version| and |release|, also used in various | |
42 | # other places throughout the built documents. |
|
42 | # other places throughout the built documents. | |
43 | # |
|
43 | # | |
44 | # The short X.Y version. |
|
44 | # The short X.Y version. | |
45 | version = '0.9' |
|
45 | version = '0.9' | |
46 | # The full version, including alpha/beta/rc tags. |
|
46 | # The full version, including alpha/beta/rc tags. | |
47 | release = '0.9.beta1' |
|
47 | release = '0.9.beta1' | |
48 |
|
48 | |||
49 | # There are two options for replacing |today|: either, you set today to some |
|
49 | # There are two options for replacing |today|: either, you set today to some | |
50 | # non-false value, then it is used: |
|
50 | # non-false value, then it is used: | |
51 | #today = '' |
|
51 | #today = '' | |
52 | # Else, today_fmt is used as the format for a strftime call. |
|
52 | # Else, today_fmt is used as the format for a strftime call. | |
53 | today_fmt = '%B %d, %Y' |
|
53 | today_fmt = '%B %d, %Y' | |
54 |
|
54 | |||
55 | # List of documents that shouldn't be included in the build. |
|
55 | # List of documents that shouldn't be included in the build. | |
56 | #unused_docs = [] |
|
56 | #unused_docs = [] | |
57 |
|
57 | |||
58 | # List of directories, relative to source directories, that shouldn't be searched |
|
58 | # List of directories, relative to source directories, that shouldn't be searched | |
59 | # for source files. |
|
59 | # for source files. | |
60 | #exclude_dirs = [] |
|
60 | #exclude_dirs = [] | |
61 |
|
61 | |||
62 | # If true, '()' will be appended to :func: etc. cross-reference text. |
|
62 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
63 | #add_function_parentheses = True |
|
63 | #add_function_parentheses = True | |
64 |
|
64 | |||
65 | # If true, the current module name will be prepended to all description |
|
65 | # If true, the current module name will be prepended to all description | |
66 | # unit titles (such as .. function::). |
|
66 | # unit titles (such as .. function::). | |
67 | #add_module_names = True |
|
67 | #add_module_names = True | |
68 |
|
68 | |||
69 | # If true, sectionauthor and moduleauthor directives will be shown in the |
|
69 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
70 | # output. They are ignored by default. |
|
70 | # output. They are ignored by default. | |
71 | #show_authors = False |
|
71 | #show_authors = False | |
72 |
|
72 | |||
73 | # The name of the Pygments (syntax highlighting) style to use. |
|
73 | # The name of the Pygments (syntax highlighting) style to use. | |
74 | pygments_style = 'sphinx' |
|
74 | pygments_style = 'sphinx' | |
75 |
|
75 | |||
76 |
|
76 | |||
77 | # Options for HTML output |
|
77 | # Options for HTML output | |
78 | # ----------------------- |
|
78 | # ----------------------- | |
79 |
|
79 | |||
80 | # The style sheet to use for HTML and HTML Help pages. A file of that name |
|
80 | # The style sheet to use for HTML and HTML Help pages. A file of that name | |
81 | # must exist either in Sphinx' static/ path, or in one of the custom paths |
|
81 | # must exist either in Sphinx' static/ path, or in one of the custom paths | |
82 | # given in html_static_path. |
|
82 | # given in html_static_path. | |
83 | html_style = 'default.css' |
|
83 | html_style = 'default.css' | |
84 |
|
84 | |||
85 | # The name for this set of Sphinx documents. If None, it defaults to |
|
85 | # The name for this set of Sphinx documents. If None, it defaults to | |
86 | # "<project> v<release> documentation". |
|
86 | # "<project> v<release> documentation". | |
87 | #html_title = None |
|
87 | #html_title = None | |
88 |
|
88 | |||
89 | # The name of an image file (within the static path) to place at the top of |
|
89 | # The name of an image file (within the static path) to place at the top of | |
90 | # the sidebar. |
|
90 | # the sidebar. | |
91 | #html_logo = None |
|
91 | #html_logo = None | |
92 |
|
92 | |||
93 | # Add any paths that contain custom static files (such as style sheets) here, |
|
93 | # Add any paths that contain custom static files (such as style sheets) here, | |
94 | # relative to this directory. They are copied after the builtin static files, |
|
94 | # relative to this directory. They are copied after the builtin static files, | |
95 | # so a file named "default.css" will overwrite the builtin "default.css". |
|
95 | # so a file named "default.css" will overwrite the builtin "default.css". | |
96 | html_static_path = ['_static'] |
|
96 | html_static_path = ['_static'] | |
97 |
|
97 | |||
98 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
98 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
99 | # using the given strftime format. |
|
99 | # using the given strftime format. | |
100 | html_last_updated_fmt = '%b %d, %Y' |
|
100 | html_last_updated_fmt = '%b %d, %Y' | |
101 |
|
101 | |||
102 | # If true, SmartyPants will be used to convert quotes and dashes to |
|
102 | # If true, SmartyPants will be used to convert quotes and dashes to | |
103 | # typographically correct entities. |
|
103 | # typographically correct entities. | |
104 | #html_use_smartypants = True |
|
104 | #html_use_smartypants = True | |
105 |
|
105 | |||
106 | # Custom sidebar templates, maps document names to template names. |
|
106 | # Custom sidebar templates, maps document names to template names. | |
107 | #html_sidebars = {} |
|
107 | #html_sidebars = {} | |
108 |
|
108 | |||
109 | # Additional templates that should be rendered to pages, maps page names to |
|
109 | # Additional templates that should be rendered to pages, maps page names to | |
110 | # template names. |
|
110 | # template names. | |
111 | #html_additional_pages = {} |
|
111 | #html_additional_pages = {} | |
112 |
|
112 | |||
113 | # If false, no module index is generated. |
|
113 | # If false, no module index is generated. | |
114 | #html_use_modindex = True |
|
114 | #html_use_modindex = True | |
115 |
|
115 | |||
116 | # If true, the reST sources are included in the HTML build as _sources/<name>. |
|
116 | # If true, the reST sources are included in the HTML build as _sources/<name>. | |
117 | #html_copy_source = True |
|
117 | #html_copy_source = True | |
118 |
|
118 | |||
119 | # If true, an OpenSearch description file will be output, and all pages will |
|
119 | # If true, an OpenSearch description file will be output, and all pages will | |
120 | # contain a <link> tag referring to it. The value of this option must be the |
|
120 | # contain a <link> tag referring to it. The value of this option must be the | |
121 | # base URL from which the finished HTML is served. |
|
121 | # base URL from which the finished HTML is served. | |
122 | #html_use_opensearch = '' |
|
122 | #html_use_opensearch = '' | |
123 |
|
123 | |||
124 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
124 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | |
125 | #html_file_suffix = '' |
|
125 | #html_file_suffix = '' | |
126 |
|
126 | |||
127 | # Output file base name for HTML help builder. |
|
127 | # Output file base name for HTML help builder. | |
128 | htmlhelp_basename = 'IPythondoc' |
|
128 | htmlhelp_basename = 'IPythondoc' | |
129 |
|
129 | |||
130 |
|
130 | |||
131 | # Options for LaTeX output |
|
131 | # Options for LaTeX output | |
132 | # ------------------------ |
|
132 | # ------------------------ | |
133 |
|
133 | |||
134 | # The paper size ('letter' or 'a4'). |
|
134 | # The paper size ('letter' or 'a4'). | |
135 | latex_paper_size = 'letter' |
|
135 | latex_paper_size = 'letter' | |
136 |
|
136 | |||
137 | # The font size ('10pt', '11pt' or '12pt'). |
|
137 | # The font size ('10pt', '11pt' or '12pt'). | |
138 | latex_font_size = '11pt' |
|
138 | latex_font_size = '11pt' | |
139 |
|
139 | |||
140 | # Grouping the document tree into LaTeX files. List of tuples |
|
140 | # Grouping the document tree into LaTeX files. List of tuples | |
141 | # (source start file, target name, title, author, document class [howto/manual]). |
|
141 | # (source start file, target name, title, author, document class [howto/manual]). | |
142 |
|
142 | |||
143 | latex_documents = [ ('index', 'IPython.tex', 'IPython Documentation', |
|
143 | latex_documents = [ ('index', 'IPython.tex', 'IPython Documentation', | |
144 |
ur"""Brian Granger |
|
144 | ur"""Brian Granger, Fernando Pérez and Ville Vainio\\ | |
|
145 | \ \\ | |||
145 | With contributions from:\\ |
|
146 | With contributions from:\\ | |
146 |
Benjamin Ragan-Kelley |
|
147 | Benjamin Ragan-Kelley.""", | |
147 | 'manual'), |
|
148 | 'manual'), | |
148 | ] |
|
149 | ] | |
149 |
|
150 | |||
150 | # The name of an image file (relative to this directory) to place at the top of |
|
151 | # The name of an image file (relative to this directory) to place at the top of | |
151 | # the title page. |
|
152 | # the title page. | |
152 | #latex_logo = None |
|
153 | #latex_logo = None | |
153 |
|
154 | |||
154 | # For "manual" documents, if this is true, then toplevel headings are parts, |
|
155 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
155 | # not chapters. |
|
156 | # not chapters. | |
156 | #latex_use_parts = False |
|
157 | #latex_use_parts = False | |
157 |
|
158 | |||
158 | # Additional stuff for the LaTeX preamble. |
|
159 | # Additional stuff for the LaTeX preamble. | |
159 | #latex_preamble = '' |
|
160 | #latex_preamble = '' | |
160 |
|
161 | |||
161 | # Documents to append as an appendix to all manuals. |
|
162 | # Documents to append as an appendix to all manuals. | |
162 | #latex_appendices = [] |
|
163 | #latex_appendices = [] | |
163 |
|
164 | |||
164 | # If false, no module index is generated. |
|
165 | # If false, no module index is generated. | |
165 | #latex_use_modindex = True |
|
166 | #latex_use_modindex = True |
General Comments 0
You need to be logged in to leave comments.
Login now