|
1 | | -# -*- coding: utf-8 -*- |
2 | 1 | # |
3 | 2 | # bpython documentation build configuration file, created by |
4 | 3 | # sphinx-quickstart on Mon Jun 8 11:58:16 2009. |
|
16 | 15 | # If extensions (or modules to document with autodoc) are in another directory, |
17 | 16 | # add these directories to sys.path here. If the directory is relative to the |
18 | 17 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
19 | | -#sys.path.append(os.path.abspath('.')) |
| 18 | +#sys.path.append(os.path.abspath('.')) |
20 | 19 |
|
21 | 20 | # -- General configuration ----------------------------------------------------- |
22 | 21 |
|
|
25 | 24 | extensions= [] |
26 | 25 |
|
27 | 26 | # Add any paths that contain templates here, relative to this directory. |
28 | | -templates_path= ['_templates'] |
| 27 | +templates_path= ["_templates"] |
29 | 28 |
|
30 | 29 | # The suffix of source filenames. |
31 | | -source_suffix='.rst' |
| 30 | +source_suffix=".rst" |
32 | 31 |
|
33 | 32 | # The encoding of source files. |
34 | | -#source_encoding = 'utf-8' |
| 33 | +#source_encoding = 'utf-8' |
35 | 34 |
|
36 | 35 | # The master toctree document. |
37 | | -master_doc='index' |
| 36 | +master_doc="index" |
38 | 37 |
|
39 | 38 | # General information about the project. |
40 | | -project=u'bpython' |
41 | | -copyright=u'2008-2021 Bob Farrell, Andreas Stuehrk, Sebastian Ramacher, Thomas Ballinger, et al.' |
| 39 | +project="bpython" |
| 40 | +copyright="2008-2022 Bob Farrell, Andreas Stuehrk, Sebastian Ramacher, Thomas Ballinger, et al." |
42 | 41 |
|
43 | 42 | # The version info for the project you're documenting, acts as replacement for |
44 | 43 | # |version| and |release|, also used in various other places throughout the |
45 | 44 | # built documents. |
46 | 45 | # |
47 | 46 | # The short X.Y version. |
48 | 47 |
|
49 | | -version_file=os.path.join(os.path.dirname(os.path.abspath(__file__)), |
50 | | -'../../../bpython/_version.py') |
| 48 | +version_file=os.path.join( |
| 49 | +os.path.dirname(os.path.abspath(__file__)),"../../../bpython/_version.py" |
| 50 | +) |
51 | 51 |
|
52 | 52 | withopen(version_file)asvf: |
53 | | -version=vf.read().strip().split('=')[-1].replace('\'','') |
| 53 | +version=vf.read().strip().split("=")[-1].replace("'","") |
54 | 54 |
|
55 | 55 | # The full version, including alpha/beta/rc tags. |
56 | 56 | release=version |
57 | 57 |
|
58 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation |
59 | 59 | # for a list of supported languages. |
60 | | -#language = None |
| 60 | +#language = None |
61 | 61 |
|
62 | 62 | # There are two options for replacing |today|: either, you set today to some |
63 | 63 | # non-false value, then it is used: |
64 | | -#today = '' |
| 64 | +#today = '' |
65 | 65 | # Else, today_fmt is used as the format for a strftime call. |
66 | | -#today_fmt = '%B %d, %Y' |
| 66 | +#today_fmt = '%B %d, %Y' |
67 | 67 |
|
68 | 68 | # List of documents that shouldn't be included in the build. |
69 | | -unused_docs= ['configuration-options'] |
| 69 | +unused_docs= ["configuration-options"] |
70 | 70 |
|
71 | 71 | # List of directories, relative to source directory, that shouldn't be searched |
72 | 72 | # for source files. |
73 | 73 | exclude_trees= [] |
74 | 74 |
|
75 | 75 | # The reST default role (used for this markup: `text`) to use for all documents. |
76 | | -#default_role = None |
| 76 | +#default_role = None |
77 | 77 |
|
78 | 78 | # If true, '()' will be appended to :func: etc. cross-reference text. |
79 | | -#add_function_parentheses = True |
| 79 | +#add_function_parentheses = True |
80 | 80 |
|
81 | 81 | # If true, the current module name will be prepended to all description |
82 | 82 | # unit titles (such as .. function::). |
83 | | -#add_module_names = True |
| 83 | +#add_module_names = True |
84 | 84 |
|
85 | 85 | # If true, sectionauthor and moduleauthor directives will be shown in the |
86 | 86 | # output. They are ignored by default. |
87 | | -#show_authors = False |
| 87 | +#show_authors = False |
88 | 88 |
|
89 | 89 | # The name of the Pygments (syntax highlighting) style to use. |
90 | | -pygments_style='sphinx' |
| 90 | +pygments_style="sphinx" |
91 | 91 |
|
92 | 92 | # A list of ignored prefixes for module index sorting. |
93 | | -#modindex_common_prefix = [] |
| 93 | +#modindex_common_prefix = [] |
94 | 94 |
|
95 | 95 |
|
96 | 96 | # -- Options for HTML output --------------------------------------------------- |
97 | 97 |
|
98 | 98 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
99 | 99 | # Sphinx are currently 'default' and 'sphinxdoc'. |
100 | | -html_theme='nature' |
| 100 | +html_theme="nature" |
101 | 101 |
|
102 | 102 | # Theme options are theme-specific and customize the look and feel of a theme |
103 | 103 | # further. For a list of options available for each theme, see the |
104 | 104 | # documentation. |
105 | | -#html_theme_options = {} |
| 105 | +#html_theme_options = {} |
106 | 106 |
|
107 | 107 | # Add any paths that contain custom themes here, relative to this directory. |
108 | | -#html_theme_path = [] |
| 108 | +#html_theme_path = [] |
109 | 109 |
|
110 | 110 | # The name for this set of Sphinx documents. If None, it defaults to |
111 | 111 | # "<project> v<release> documentation". |
112 | | -#html_title = None |
| 112 | +#html_title = None |
113 | 113 |
|
114 | 114 | # A shorter title for the navigation bar. Default is the same as html_title. |
115 | | -#html_short_title = None |
| 115 | +#html_short_title = None |
116 | 116 |
|
117 | 117 | # The name of an image file (relative to this directory) to place at the top |
118 | 118 | # of the sidebar. |
119 | | -html_logo='logo.png' |
| 119 | +html_logo="logo.png" |
120 | 120 |
|
121 | 121 | # The name of an image file (within the static path) to use as favicon of the |
122 | 122 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
123 | 123 | # pixels large. |
124 | | -#html_favicon = None |
| 124 | +#html_favicon = None |
125 | 125 |
|
126 | 126 | # Add any paths that contain custom static files (such as style sheets) here, |
127 | 127 | # relative to this directory. They are copied after the builtin static files, |
128 | 128 | # so a file named "default.css" will overwrite the builtin "default.css". |
129 | | -html_static_path= ['_static'] |
| 129 | +html_static_path= ["_static"] |
130 | 130 |
|
131 | 131 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
132 | 132 | # using the given strftime format. |
133 | | -html_last_updated_fmt='%b %d, %Y' |
| 133 | +html_last_updated_fmt="%b %d, %Y" |
134 | 134 |
|
135 | 135 | # If true, SmartyPants will be used to convert quotes and dashes to |
136 | 136 | # typographically correct entities. |
137 | | -#html_use_smartypants = True |
| 137 | +#html_use_smartypants = True |
138 | 138 |
|
139 | 139 | # Custom sidebar templates, maps document names to template names. |
140 | | -#html_sidebars = {} |
| 140 | +#html_sidebars = {} |
141 | 141 |
|
142 | 142 | # Additional templates that should be rendered to pages, maps page names to |
143 | 143 | # template names. |
144 | | -#html_additional_pages = {} |
| 144 | +#html_additional_pages = {} |
145 | 145 |
|
146 | 146 | # If false, no module index is generated. |
147 | | -#html_use_modindex = True |
| 147 | +#html_use_modindex = True |
148 | 148 |
|
149 | 149 | # If false, no index is generated. |
150 | | -#html_use_index = True |
| 150 | +#html_use_index = True |
151 | 151 |
|
152 | 152 | # If true, the index is split into individual pages for each letter. |
153 | | -#html_split_index = False |
| 153 | +#html_split_index = False |
154 | 154 |
|
155 | 155 | # If true, links to the reST sources are added to the pages. |
156 | | -#html_show_sourcelink = True |
| 156 | +#html_show_sourcelink = True |
157 | 157 |
|
158 | 158 | # If true, an OpenSearch description file will be output, and all pages will |
159 | 159 | # contain a <link> tag referring to it. The value of this option must be the |
160 | 160 | # base URL from which the finished HTML is served. |
161 | | -html_use_opensearch='' |
| 161 | +html_use_opensearch="" |
162 | 162 |
|
163 | 163 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
164 | | -#html_file_suffix = '' |
| 164 | +#html_file_suffix = '' |
165 | 165 |
|
166 | 166 | # Output file base name for HTML help builder. |
167 | | -htmlhelp_basename='bpythondoc' |
| 167 | +htmlhelp_basename="bpythondoc" |
168 | 168 |
|
169 | 169 |
|
170 | 170 | # -- Options for LaTeX output -------------------------------------------------- |
171 | 171 |
|
172 | 172 | # The paper size ('letter' or 'a4'). |
173 | | -#latex_paper_size = 'letter' |
| 173 | +#latex_paper_size = 'letter' |
174 | 174 |
|
175 | 175 | # The font size ('10pt', '11pt' or '12pt'). |
176 | | -#latex_font_size = '10pt' |
| 176 | +#latex_font_size = '10pt' |
177 | 177 |
|
178 | 178 | # Grouping the document tree into LaTeX files. List of tuples |
179 | 179 | # (source start file, target name, title, author, documentclass [howto/manual]). |
180 | | -#latex_documents = [ |
| 180 | +#latex_documents = [ |
181 | 181 | # ('index', 'bpython.tex', u'bpython Documentation', |
182 | 182 | # u'Robert Farrell', 'manual'), |
183 | | -#] |
| 183 | +#] |
184 | 184 |
|
185 | 185 | # The name of an image file (relative to this directory) to place at the top of |
186 | 186 | # the title page. |
187 | | -#latex_logo = None |
| 187 | +#latex_logo = None |
188 | 188 |
|
189 | 189 | # For "manual" documents, if this is true, then toplevel headings are parts, |
190 | 190 | # not chapters. |
191 | | -#latex_use_parts = False |
| 191 | +#latex_use_parts = False |
192 | 192 |
|
193 | 193 | # Additional stuff for the LaTeX preamble. |
194 | | -#latex_preamble = '' |
| 194 | +#latex_preamble = '' |
195 | 195 |
|
196 | 196 | # Documents to append as an appendix to all manuals. |
197 | | -#latex_appendices = [] |
| 197 | +#latex_appendices = [] |
198 | 198 |
|
199 | 199 | # If false, no module index is generated. |
200 | | -#latex_use_modindex = True |
| 200 | +#latex_use_modindex = True |
201 | 201 |
|
202 | 202 | # -- Options for manual page output -------------------------------------------- |
203 | 203 |
|
204 | 204 | # One entry per manual page. List of tuples |
205 | 205 | # (source start file, name, description, authors, manual section). |
206 | 206 | man_pages= [ |
207 | | - ('man-bpython','bpython', |
208 | | -u'a fancy {curtsies, curses, urwid} interface to the Python interactive interpreter', |
209 | | - [],1), |
210 | | - ('man-bpython-config','bpython-config', |
211 | | -u'user configuration file for bpython', |
212 | | - [],5) |
| 207 | + ( |
| 208 | +"man-bpython", |
| 209 | +"bpython", |
| 210 | +"a fancy {curtsies, curses, urwid} interface to the Python interactive interpreter", |
| 211 | + [], |
| 212 | +1, |
| 213 | + ), |
| 214 | + ( |
| 215 | +"man-bpython-config", |
| 216 | +"bpython-config", |
| 217 | +"user configuration file for bpython", |
| 218 | + [], |
| 219 | +5, |
| 220 | + ), |
213 | 221 | ] |
214 | 222 |
|
215 | 223 | # If true, show URL addresses after external links. |
216 | | -#man_show_urls = False |
217 | | - |
| 224 | +# man_show_urls = False |