|
15 | 15 | # If extensions (or modules to document with autodoc) are in another directory, |
16 | 16 | # add these directories to sys.path here. If the directory is relative to the |
17 | 17 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
18 | | -#sys.path.append(os.path.abspath('.')) |
| 18 | +# sys.path.append(os.path.abspath('.')) |
19 | 19 |
|
20 | 20 | # -- General configuration ----------------------------------------------------- |
21 | 21 |
|
22 | 22 | # Add any Sphinx extension module names here, as strings. They can be extensions |
23 | 23 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
24 | | -extensions = ['sphinx.ext.autodoc'] |
| 24 | +extensions = ["sphinx.ext.autodoc"] |
25 | 25 | try: |
26 | 26 | import sphinx.ext.viewcode |
27 | | - extensions.append('sphinx.ext.viewcode') |
| 27 | + |
| 28 | + extensions.append("sphinx.ext.viewcode") |
28 | 29 | except ImportError: |
29 | 30 | print("WARNING: the Sphinx viewcode extension was not found", file=sys.stderr) |
30 | 31 |
|
31 | 32 | # Add any paths that contain templates here, relative to this directory. |
32 | | -templates_path = ['_templates'] |
| 33 | +templates_path = ["_templates"] |
33 | 34 |
|
34 | 35 | # The suffix of source filenames. |
35 | | -source_suffix = '.rst' |
| 36 | +source_suffix = ".rst" |
36 | 37 |
|
37 | 38 | # The encoding of source files. |
38 | | -#source_encoding = 'utf-8' |
| 39 | +# source_encoding = 'utf-8' |
39 | 40 |
|
40 | 41 | # The master toctree document. |
41 | | -master_doc = 'index' |
| 42 | +master_doc = "index" |
42 | 43 |
|
43 | 44 | # General information about the project. |
44 | | -project = 'PythonQwt' |
| 45 | +project = "PythonQwt" |
45 | 46 | import time |
| 47 | + |
46 | 48 | this_year = time.strftime("%Y", time.localtime()) |
47 | 49 | copyright = "2002 Uwe Rathmann (for the original C++ code/doc), 2015 Pierre Raybaut (for the Python translation/optimization/doc adaptation)" |
48 | 50 |
|
|
52 | 54 | # |
53 | 55 | # The short X.Y version. |
54 | 56 | import qwt |
55 | | -version = ".".join(qwt.__version__.split('.')[:2]) |
| 57 | + |
| 58 | +version = ".".join(qwt.__version__.split(".")[:2]) |
56 | 59 | # The full version, including alpha/beta/rc tags. |
57 | 60 | release = qwt.__version__ |
58 | 61 |
|
59 | 62 | # The language for content autogenerated by Sphinx. Refer to documentation |
60 | 63 | # for a list of supported languages. |
61 | | -#language = None |
| 64 | +# language = None |
62 | 65 |
|
63 | 66 | # There are two options for replacing |today|: either, you set today to some |
64 | 67 | # non-false value, then it is used: |
65 | | -#today = '' |
| 68 | +# today = '' |
66 | 69 | # Else, today_fmt is used as the format for a strftime call. |
67 | | -#today_fmt = '%B %d, %Y' |
| 70 | +# today_fmt = '%B %d, %Y' |
68 | 71 |
|
69 | 72 | # List of documents that shouldn't be included in the build. |
70 | | -#unused_docs = [] |
| 73 | +# unused_docs = [] |
71 | 74 |
|
72 | 75 | # List of directories, relative to source directory, that shouldn't be searched |
73 | 76 | # for source files. |
74 | 77 | exclude_trees = [] |
75 | 78 |
|
76 | 79 | # The reST default role (used for this markup: `text`) to use for all documents. |
77 | | -#default_role = None |
| 80 | +# default_role = None |
78 | 81 |
|
79 | 82 | # If true, '()' will be appended to :func: etc. cross-reference text. |
80 | | -#add_function_parentheses = True |
| 83 | +# add_function_parentheses = True |
81 | 84 |
|
82 | 85 | # If true, the current module name will be prepended to all description |
83 | 86 | # unit titles (such as .. function::). |
84 | | -#add_module_names = True |
| 87 | +# add_module_names = True |
85 | 88 |
|
86 | 89 | # If true, sectionauthor and moduleauthor directives will be shown in the |
87 | 90 | # output. They are ignored by default. |
88 | | -#show_authors = False |
| 91 | +# show_authors = False |
89 | 92 |
|
90 | 93 | # The name of the Pygments (syntax highlighting) style to use. |
91 | | -pygments_style = 'sphinx' |
| 94 | +pygments_style = "sphinx" |
92 | 95 |
|
93 | 96 | # A list of ignored prefixes for module index sorting. |
94 | | -modindex_common_prefix = ['qwt.'] |
| 97 | +modindex_common_prefix = ["qwt."] |
95 | 98 |
|
96 | | -autodoc_member_order = 'bysource' |
| 99 | +autodoc_member_order = "bysource" |
97 | 100 |
|
98 | 101 |
|
99 | 102 | # -- Options for HTML output --------------------------------------------------- |
100 | 103 |
|
101 | 104 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
102 | 105 | # Sphinx are currently 'default' and 'sphinxdoc'. |
103 | | -html_theme = 'sphinxdoc' |
| 106 | +html_theme = "classic" |
104 | 107 |
|
105 | 108 | # Theme options are theme-specific and customize the look and feel of a theme |
106 | 109 | # further. For a list of options available for each theme, see the |
|
109 | 112 | ## 'sidebarlinkcolor': '#98ff99'} |
110 | 113 |
|
111 | 114 | # Add any paths that contain custom themes here, relative to this directory. |
112 | | -#html_theme_path = [] |
| 115 | +# html_theme_path = [] |
113 | 116 |
|
114 | 117 | # The name for this set of Sphinx documents. If None, it defaults to |
115 | 118 | # "<project> v<release> documentation". |
116 | | -html_title = '%s %s Manual' % (project, version) |
| 119 | +html_title = "%s %s Manual" % (project, version) |
117 | 120 |
|
118 | 121 | # A shorter title for the navigation bar. Default is the same as html_title. |
119 | | -#html_short_title = '%s Manual' % project |
| 122 | +# html_short_title = '%s Manual' % project |
120 | 123 |
|
121 | 124 | # The name of an image file (relative to this directory) to place at the top |
122 | 125 | # of the sidebar. |
123 | | -#html_logo = 'images/qwt.png' |
| 126 | +# html_logo = 'images/qwt.png' |
124 | 127 |
|
125 | 128 | # The name of an image file (within the static path) to use as favicon of the |
126 | 129 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
127 | 130 | # pixels large. |
128 | | -#html_favicon = 'favicon.ico' |
| 131 | +# html_favicon = 'favicon.ico' |
129 | 132 |
|
130 | 133 | # Add any paths that contain custom static files (such as style sheets) here, |
131 | 134 | # relative to this directory. They are copied after the builtin static files, |
132 | 135 | # so a file named "default.css" will overwrite the builtin "default.css". |
133 | | -html_static_path = ['_static'] |
| 136 | +html_static_path = ["_static"] |
134 | 137 |
|
135 | 138 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
136 | 139 | # using the given strftime format. |
137 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 140 | +# html_last_updated_fmt = '%b %d, %Y' |
138 | 141 |
|
139 | 142 | # If true, SmartyPants will be used to convert quotes and dashes to |
140 | 143 | # typographically correct entities. |
141 | | -#html_use_smartypants = True |
| 144 | +# html_use_smartypants = True |
142 | 145 |
|
143 | 146 | # Custom sidebar templates, maps document names to template names. |
144 | | -#html_sidebars = {} |
| 147 | +# html_sidebars = {} |
145 | 148 |
|
146 | 149 | # Additional templates that should be rendered to pages, maps page names to |
147 | 150 | # template names. |
148 | | -#html_additional_pages = {} |
| 151 | +# html_additional_pages = {} |
149 | 152 |
|
150 | 153 | # If false, no module index is generated. |
151 | 154 | html_use_modindex = True |
152 | 155 |
|
153 | 156 | # If false, no index is generated. |
154 | | -#html_use_index = True |
| 157 | +# html_use_index = True |
155 | 158 |
|
156 | 159 | # If true, the index is split into individual pages for each letter. |
157 | | -#html_split_index = False |
| 160 | +# html_split_index = False |
158 | 161 |
|
159 | 162 | # If true, links to the reST sources are added to the pages. |
160 | | -#html_show_sourcelink = True |
| 163 | +# html_show_sourcelink = True |
161 | 164 |
|
162 | 165 | # If true, an OpenSearch description file will be output, and all pages will |
163 | 166 | # contain a <link> tag referring to it. The value of this option must be the |
164 | 167 | # base URL from which the finished HTML is served. |
165 | | -#html_use_opensearch = '' |
| 168 | +# html_use_opensearch = '' |
166 | 169 |
|
167 | 170 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
168 | | -#html_file_suffix = '' |
| 171 | +# html_file_suffix = '' |
169 | 172 |
|
170 | 173 | # Output file base name for HTML help builder. |
171 | | -htmlhelp_basename = 'PythonQwt' |
| 174 | +htmlhelp_basename = "PythonQwt" |
172 | 175 |
|
173 | 176 |
|
174 | 177 | # -- Options for LaTeX output -------------------------------------------------- |
175 | 178 |
|
176 | 179 | # The paper size ('letter' or 'a4'). |
177 | | -#latex_paper_size = 'letter' |
| 180 | +# latex_paper_size = 'letter' |
178 | 181 |
|
179 | 182 | # The font size ('10pt', '11pt' or '12pt'). |
180 | | -#latex_font_size = '10pt' |
| 183 | +# latex_font_size = '10pt' |
181 | 184 |
|
182 | 185 | # Grouping the document tree into LaTeX files. List of tuples |
183 | 186 | # (source start file, target name, title, author, documentclass [howto/manual]). |
184 | 187 | latex_documents = [ |
185 | | - ('index', 'qwt.tex', 'PythonQwt Manual', 'Pierre Raybaut', 'manual'), |
| 188 | + ("index", "qwt.tex", "PythonQwt Manual", "Pierre Raybaut", "manual"), |
186 | 189 | ] |
187 | 190 |
|
188 | 191 | # The name of an image file (relative to this directory) to place at the top of |
189 | 192 | # the title page. |
190 | | -#latex_logo = None |
| 193 | +# latex_logo = None |
191 | 194 |
|
192 | 195 | # For "manual" documents, if this is true, then toplevel headings are parts, |
193 | 196 | # not chapters. |
194 | | -#latex_use_parts = False |
| 197 | +# latex_use_parts = False |
195 | 198 |
|
196 | 199 | # Additional stuff for the LaTeX preamble. |
197 | | -#latex_preamble = '' |
| 200 | +# latex_preamble = '' |
198 | 201 |
|
199 | 202 | # Documents to append as an appendix to all manuals. |
200 | | -#latex_appendices = [] |
| 203 | +# latex_appendices = [] |
201 | 204 |
|
202 | 205 | # If false, no module index is generated. |
203 | | -#latex_use_modindex = True |
| 206 | +# latex_use_modindex = True |
| 207 | + |
0 commit comments