|
1 | 1 | import os |
| 2 | + |
2 | 3 | # -*- coding: utf-8 -*- |
3 | 4 | # |
4 | 5 | # ITKPythonPackage documentation build configuration file, created by |
|
34 | 35 | extensions = [] |
35 | 36 |
|
36 | 37 | # Add any paths that contain templates here, relative to this directory. |
37 | | -templates_path = ['_templates'] |
| 38 | +templates_path = ["_templates"] |
38 | 39 |
|
39 | 40 | # The suffix(es) of source filenames. |
40 | 41 | # You can specify multiple suffix as a list of string: |
41 | 42 | # |
42 | 43 | # source_suffix = ['.rst', '.md'] |
43 | | -source_suffix = '.rst' |
| 44 | +source_suffix = ".rst" |
44 | 45 |
|
45 | 46 | # The master toctree document. |
46 | | -master_doc = 'index' |
| 47 | +master_doc = "index" |
47 | 48 |
|
48 | 49 | # General information about the project. |
49 | | -project = u'ITKPythonPackage' |
50 | | -copyright = u'2017, Jean-Christophe Fillion-Robin and Matt McCormick' |
51 | | -author = u'Jean-Christophe Fillion-Robin and Matt McCormick' |
| 50 | +project = "ITKPythonPackage" |
| 51 | +copyright = "2017, Jean-Christophe Fillion-Robin and Matt McCormick" |
| 52 | +author = "Jean-Christophe Fillion-Robin and Matt McCormick" |
52 | 53 |
|
53 | 54 | # The version info for the project you're documenting, acts as replacement for |
54 | 55 | # |version| and |release|, also used in various other places throughout the |
55 | 56 | # built documents. |
56 | 57 | # |
57 | 58 | # The short X.Y version. |
58 | | -version = u'' |
| 59 | +version = "" |
59 | 60 | # The full version, including alpha/beta/rc tags. |
60 | | -release = u'' |
| 61 | +release = "" |
61 | 62 |
|
62 | 63 | # The language for content autogenerated by Sphinx. Refer to documentation |
63 | 64 | # for a list of supported languages. |
|
69 | 70 | # List of patterns, relative to source directory, that match files and |
70 | 71 | # directories to ignore when looking for source files. |
71 | 72 | # This patterns also effect to html_static_path and html_extra_path |
72 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 73 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
73 | 74 |
|
74 | 75 | # The name of the Pygments (syntax highlighting) style to use. |
75 | | -pygments_style = 'sphinx' |
| 76 | +pygments_style = "sphinx" |
76 | 77 |
|
77 | 78 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
78 | 79 | todo_include_todos = False |
|
83 | 84 | # The theme to use for HTML and HTML Help pages. See the documentation for |
84 | 85 | # a list of builtin themes. |
85 | 86 | # |
86 | | -html_theme = 'default' |
| 87 | +html_theme = "default" |
87 | 88 |
|
88 | 89 | # Theme options are theme-specific and customize the look and feel of a theme |
89 | 90 | # further. For a list of options available for each theme, see the |
|
94 | 95 | # Add any paths that contain custom static files (such as style sheets) here, |
95 | 96 | # relative to this directory. They are copied after the builtin static files, |
96 | 97 | # so a file named "default.css" will overwrite the builtin "default.css". |
97 | | -html_static_path = ['_static'] |
| 98 | +html_static_path = ["_static"] |
98 | 99 |
|
99 | 100 |
|
100 | 101 | # -- Options for HTMLHelp output ------------------------------------------ |
101 | 102 |
|
102 | 103 | # Output file base name for HTML help builder. |
103 | | -htmlhelp_basename = 'ITKPythonPackagedoc' |
| 104 | +htmlhelp_basename = "ITKPythonPackagedoc" |
104 | 105 |
|
105 | 106 |
|
106 | 107 | # -- Options for LaTeX output --------------------------------------------- |
|
109 | 110 | # The paper size ('letterpaper' or 'a4paper'). |
110 | 111 | # |
111 | 112 | # 'papersize': 'letterpaper', |
112 | | - |
113 | 113 | # The font size ('10pt', '11pt' or '12pt'). |
114 | 114 | # |
115 | 115 | # 'pointsize': '10pt', |
116 | | - |
117 | 116 | # Additional stuff for the LaTeX preamble. |
118 | 117 | # |
119 | 118 | # 'preamble': '', |
120 | | - |
121 | 119 | # Latex figure (float) alignment |
122 | 120 | # |
123 | 121 | # 'figure_align': 'htbp', |
|
127 | 125 | # (source start file, target name, title, |
128 | 126 | # author, documentclass [howto, manual, or own class]). |
129 | 127 | latex_documents = [ |
130 | | - (master_doc, 'ITKPythonPackage.tex', u'ITKPythonPackage Documentation', |
131 | | - u'Jean-Christophe Fillion-Robin and Matt McCormick', 'manual'), |
| 128 | + ( |
| 129 | + master_doc, |
| 130 | + "ITKPythonPackage.tex", |
| 131 | + "ITKPythonPackage Documentation", |
| 132 | + "Jean-Christophe Fillion-Robin and Matt McCormick", |
| 133 | + "manual", |
| 134 | + ), |
132 | 135 | ] |
133 | 136 |
|
134 | 137 |
|
|
137 | 140 | # One entry per manual page. List of tuples |
138 | 141 | # (source start file, name, description, authors, manual section). |
139 | 142 | man_pages = [ |
140 | | - (master_doc, 'itkpythonpackage', u'ITKPythonPackage Documentation', |
141 | | - [author], 1) |
| 143 | + (master_doc, "itkpythonpackage", "ITKPythonPackage Documentation", [author], 1) |
142 | 144 | ] |
143 | 145 |
|
144 | 146 |
|
|
148 | 150 | # (source start file, target name, title, author, |
149 | 151 | # dir menu entry, description, category) |
150 | 152 | texinfo_documents = [ |
151 | | - (master_doc, 'ITKPythonPackage', u'ITKPythonPackage Documentation', |
152 | | - author, 'ITKPythonPackage', 'One line description of project.', |
153 | | - 'Miscellaneous'), |
| 153 | + ( |
| 154 | + master_doc, |
| 155 | + "ITKPythonPackage", |
| 156 | + "ITKPythonPackage Documentation", |
| 157 | + author, |
| 158 | + "ITKPythonPackage", |
| 159 | + "One line description of project.", |
| 160 | + "Miscellaneous", |
| 161 | + ), |
154 | 162 | ] |
155 | 163 |
|
156 | 164 |
|
157 | 165 | # -- Read The Docs ----------------------------------------------------- |
158 | 166 |
|
159 | 167 | # on_rtd is whether we are on readthedocs.io |
160 | | -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 168 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
161 | 169 |
|
162 | 170 | if not on_rtd: # only import and set the theme if we're building docs locally |
163 | 171 | import sphinx_rtd_theme |
164 | | - html_theme = 'sphinx_rtd_theme' |
165 | | - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
166 | 172 |
|
| 173 | + html_theme = "sphinx_rtd_theme" |
| 174 | + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
0 commit comments