|
16 | 16 | import sys |
17 | 17 | import sphinx_rtd_theme |
18 | 18 |
|
19 | | -sys.path.insert(0, os.path.abspath('./../...')) |
| 19 | +sys.path.insert(0, os.path.abspath("./../...")) |
20 | 20 | # sys.path.insert(0, os.path.abspath('.')) |
21 | 21 | # sys.path.insert(0, os.path.abspath('../src')) |
22 | 22 |
|
|
26 | 26 |
|
27 | 27 | # -- Project information ----------------------------------------------------- |
28 | 28 |
|
29 | | -project = 'OctaDist' |
30 | | -copyright = '2019-2024, Rangsiman Ketkaew et al.' |
31 | | -author = 'Rangsiman Ketkaew' |
| 29 | +project = "OctaDist" |
| 30 | +copyright = "2019-2026, Rangsiman Ketkaew et al." |
| 31 | +author = "Rangsiman Ketkaew" |
32 | 32 |
|
33 | 33 | # The short X.Y version |
34 | | -version = '3.1.0' |
| 34 | +version = "3.1.0" |
35 | 35 | # The full version, including alpha/beta/rc tags |
36 | | -release = '3.1.0' |
| 36 | +release = "3.1.0" |
37 | 37 |
|
38 | 38 | # Not alphabetically order |
39 | | -autodoc_member_order = 'bysource' |
| 39 | +autodoc_member_order = "bysource" |
40 | 40 | # autodoc_mock_imports = ['tkinter'] |
41 | 41 | autodoc_mock_imports = [ |
42 | | - # "octadist", |
43 | | - "TkAgg", |
44 | | - "pymatgen" |
45 | | - ] |
| 42 | + # "octadist", |
| 43 | + "TkAgg", |
| 44 | + "pymatgen", |
| 45 | +] |
46 | 46 |
|
47 | 47 | # -- General configuration --------------------------------------------------- |
48 | 48 |
|
|
54 | 54 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
55 | 55 | # ones. |
56 | 56 | extensions = [ |
57 | | - 'sphinx.ext.autodoc', |
58 | | - 'sphinx.ext.intersphinx', |
59 | | - 'sphinx.ext.mathjax', |
60 | | - 'sphinx.ext.viewcode', |
61 | | - 'sphinx.ext.githubpages', |
62 | | - 'sphinx.ext.napoleon', |
63 | | - 'sphinx_rtd_theme', |
| 57 | + "sphinx.ext.autodoc", |
| 58 | + "sphinx.ext.intersphinx", |
| 59 | + "sphinx.ext.mathjax", |
| 60 | + "sphinx.ext.viewcode", |
| 61 | + "sphinx.ext.githubpages", |
| 62 | + "sphinx.ext.napoleon", |
| 63 | + "sphinx_rtd_theme", |
64 | 64 | ] |
65 | 65 |
|
66 | 66 | # import numpydoc |
|
85 | 85 | napoleon_use_rtype = False |
86 | 86 |
|
87 | 87 | # Add any paths that contain templates here, relative to this directory. |
88 | | -templates_path = ['_templates'] |
| 88 | +templates_path = ["_templates"] |
89 | 89 |
|
90 | 90 | # The suffix(es) of source filenames. |
91 | 91 | # You can specify multiple suffix as a list of string: |
92 | 92 | # |
93 | 93 | # source_suffix = ['.rst', '.md'] |
94 | | -source_suffix = '.rst' |
| 94 | +source_suffix = ".rst" |
95 | 95 |
|
96 | 96 | # The master toctree document. |
97 | | -master_doc = 'index' |
| 97 | +master_doc = "index" |
98 | 98 |
|
99 | 99 | # List of patterns, relative to source directory, that match files and |
100 | 100 | # directories to ignore when looking for source files. |
101 | 101 | # This pattern also affects html_static_path and html_extra_path. |
102 | | -exclude_patterns = ['_build'] |
| 102 | +exclude_patterns = ["_build"] |
103 | 103 |
|
104 | 104 | # The name of the Pygments (syntax highlighting) style to use. |
105 | | -pygments_style = 'sphinx' |
| 105 | +pygments_style = "sphinx" |
106 | 106 |
|
107 | 107 | todo_include_todos = False |
108 | 108 |
|
|
111 | 111 | # The theme to use for HTML and HTML Help pages. See the documentation for |
112 | 112 | # a list of builtin themes. |
113 | 113 | # |
114 | | -html_theme = 'sphinx_rtd_theme' |
| 114 | +html_theme = "sphinx_rtd_theme" |
115 | 115 | # html_theme = 'default' |
116 | 116 | # html_theme = 'alabaster' |
117 | 117 |
|
118 | 118 | # Theme options are theme-specific and customize the look and feel of a theme |
119 | | -html_theme_path = ['.'] |
| 119 | +html_theme_path = ["."] |
120 | 120 |
|
121 | 121 | # Theme options |
122 | 122 | # further. For a list of options available for each theme, see the |
|
126 | 126 | # 'typekit_id': 'hiw1hhg', |
127 | 127 | # 'analytics_id': '', |
128 | 128 | # 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling. |
129 | | - 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text |
130 | | - 'collapse_navigation': False, # Collapse navigation (False makes it tree-like) |
| 129 | + "logo_only": True, # if we have a html_logo below, this shows /only/ the logo with no title text |
| 130 | + "collapse_navigation": False, # Collapse navigation (False makes it tree-like) |
131 | 131 | # 'display_version': True, # Display the docs version |
132 | 132 | # 'navigation_depth': 4, # Depth of the headers shown in the navigation bar |
133 | 133 | } |
|
141 | 141 | "conf_py_path": "/", # Path in the checkout to the docs root |
142 | 142 | } |
143 | 143 |
|
144 | | -html_logo = '../images/molecule.png' |
| 144 | +html_logo = "../images/molecule.png" |
145 | 145 |
|
146 | 146 | # Add any paths that contain custom static files (such as style sheets) here, |
147 | 147 | # relative to this directory. They are copied after the builtin static files, |
|
162 | 162 | # -- Options for HTMLHelp output --------------------------------------------- |
163 | 163 |
|
164 | 164 | # Output file base name for HTML help builder. |
165 | | -htmlhelp_basename = 'OctaDistdoc' |
| 165 | +htmlhelp_basename = "OctaDistdoc" |
166 | 166 |
|
167 | 167 | # -- Options for LaTeX output ------------------------------------------------ |
168 | 168 |
|
169 | 169 | latex_elements = { |
170 | 170 | # The paper size ('letterpaper' or 'a4paper'). |
171 | 171 | # |
172 | 172 | # 'papersize': 'letterpaper', |
173 | | - |
174 | 173 | # The font size ('10pt', '11pt' or '12pt'). |
175 | 174 | # |
176 | 175 | # 'pointsize': '10pt', |
177 | | - |
178 | 176 | # Additional stuff for the LaTeX preamble. |
179 | 177 | # |
180 | 178 | # 'preamble': '', |
181 | | - |
182 | 179 | # Latex figure (float) alignment |
183 | 180 | # |
184 | 181 | # 'figure_align': 'htbp', |
185 | | - |
186 | 182 | # Avoid blank pages in generated PDF file |
187 | | - 'extraclassoptions': 'openany,oneside' |
| 183 | + "extraclassoptions": "openany,oneside" |
188 | 184 | } |
189 | 185 |
|
190 | 186 | # Grouping the document tree into LaTeX files. List of tuples |
191 | 187 | # (source start file, target name, title, |
192 | 188 | # author, documentclass [howto, manual, or own class]). |
193 | 189 | latex_documents = [ |
194 | | - (master_doc, 'OctaDist.tex', 'OctaDist Documentation', |
195 | | - 'OctaDist Development Team', 'manual'), |
| 190 | + ( |
| 191 | + master_doc, |
| 192 | + "OctaDist.tex", |
| 193 | + "OctaDist Documentation", |
| 194 | + "OctaDist Development Team", |
| 195 | + "manual", |
| 196 | + ), |
196 | 197 | ] |
197 | 198 |
|
198 | 199 | # -- Options for manual page output ------------------------------------------ |
199 | 200 |
|
200 | 201 | # One entry per manual page. List of tuples |
201 | 202 | # (source start file, name, description, authors, manual section). |
202 | | -man_pages = [ |
203 | | - (master_doc, 'octadist', 'OctaDist Documentation', |
204 | | - [author], 1) |
205 | | -] |
| 203 | +man_pages = [(master_doc, "octadist", "OctaDist Documentation", [author], 1)] |
206 | 204 |
|
207 | 205 | # -- Options for Texinfo output ---------------------------------------------- |
208 | 206 |
|
209 | 207 | # Grouping the document tree into Texinfo files. List of tuples |
210 | 208 | # (source start file, target name, title, author, |
211 | 209 | # dir menu entry, description, category) |
212 | 210 | texinfo_documents = [ |
213 | | - (master_doc, 'OctaDist', 'OctaDist Documentation', |
214 | | - author, 'OctaDist', 'One line description of project.', |
215 | | - 'Miscellaneous'), |
| 211 | + ( |
| 212 | + master_doc, |
| 213 | + "OctaDist", |
| 214 | + "OctaDist Documentation", |
| 215 | + author, |
| 216 | + "OctaDist", |
| 217 | + "One line description of project.", |
| 218 | + "Miscellaneous", |
| 219 | + ), |
216 | 220 | ] |
217 | 221 |
|
218 | 222 | # -- Options for Epub output ------------------------------------------------- |
|
230 | 234 | # epub_uid = '' |
231 | 235 |
|
232 | 236 | # A list of files that should not be packed into the epub file. |
233 | | -epub_exclude_files = ['search.html'] |
| 237 | +epub_exclude_files = ["search.html"] |
234 | 238 |
|
235 | 239 | # -- Extension configuration ------------------------------------------------- |
236 | 240 |
|
|
0 commit comments