|
21 | 21 | # http://www.sphinx-doc.org/en/master/config |
22 | 22 |
|
23 | 23 | import os |
| 24 | + |
24 | 25 | import git |
25 | 26 |
|
26 | 27 | # -- Project information ----------------------------------------------------- |
27 | 28 |
|
28 | | -project = u'SCF' |
29 | | -copyright = u'2024, NWChemEx Team' |
30 | | -author = u'NWChemEx Team' |
| 29 | +project = "SCF" |
| 30 | +copyright = "2024, NWChemEx Team" |
| 31 | +author = "NWChemEx Team" |
31 | 32 |
|
32 | 33 | ############################################################################## |
33 | 34 | # Shouldn't need to change anything below this point # |
|
61 | 62 |
|
62 | 63 | # If your documentation needs a minimal Sphinx version, state it here. |
63 | 64 | # |
64 | | -needs_sphinx = '7.2.6' |
| 65 | +needs_sphinx = "7.2.6" |
65 | 66 |
|
66 | 67 | # Add any Sphinx extension module names here, as strings. They can be |
67 | 68 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
68 | 69 | # ones. |
69 | 70 | extensions = [ |
70 | | - 'sphinx.ext.autodoc', |
71 | | - 'sphinx.ext.mathjax', |
72 | | - 'sphinx.ext.githubpages', |
73 | | - 'sphinx.ext.autosummary', |
74 | | - 'sphinx_rtd_theme', |
| 71 | + "sphinx.ext.autodoc", |
| 72 | + "sphinx.ext.mathjax", |
| 73 | + "sphinx.ext.githubpages", |
| 74 | + "sphinx.ext.autosummary", |
| 75 | + "sphinx_rtd_theme", |
75 | 76 | # 'sphinxcontrib.bibtex', |
76 | | - 'sphinx_tabs.tabs', |
77 | | - 'sphinx.ext.intersphinx', |
| 77 | + "sphinx_tabs.tabs", |
| 78 | + "sphinx.ext.intersphinx", |
78 | 79 | ] |
79 | 80 |
|
80 | 81 | # Add any paths that contain templates here, relative to this directory. |
81 | | -#templates_path = ['_templates'] |
| 82 | +# templates_path = ['_templates'] |
82 | 83 |
|
83 | 84 | # The suffix(es) of source filenames. |
84 | 85 | # You can specify multiple suffix as a list of string: |
85 | 86 | # |
86 | 87 | # source_suffix = ['.rst', '.md'] |
87 | | -source_suffix = '.rst' |
| 88 | +source_suffix = ".rst" |
88 | 89 |
|
89 | 90 | # The master toctree document. |
90 | | -master_doc = 'index' |
| 91 | +master_doc = "index" |
91 | 92 |
|
92 | 93 | # The language for content autogenerated by Sphinx. Refer to documentation |
93 | 94 | # for a list of supported languages. |
94 | 95 | # |
95 | 96 | # This is also used if you do content translation via gettext catalogs. |
96 | 97 | # Usually you set "language" from the command line for these cases. |
97 | | -language = 'en' |
| 98 | +language = "en" |
98 | 99 |
|
99 | 100 | # List of patterns, relative to source directory, that match files and |
100 | 101 | # directories to ignore when looking for source files. |
101 | 102 | # This pattern also affects html_static_path and html_extra_path . |
102 | 103 | exclude_patterns = [] |
103 | 104 |
|
104 | 105 | # The name of the Pygments (syntax highlighting) style to use. |
105 | | -pygments_style = 'sphinx' |
| 106 | +pygments_style = "sphinx" |
106 | 107 |
|
107 | 108 | numfig = True |
108 | 109 | numfig_secnum_depth = 0 |
|
112 | 113 | # The theme to use for HTML and HTML Help pages. See the documentation for |
113 | 114 | # a list of builtin themes. |
114 | 115 | # |
115 | | -html_theme = 'sphinx_rtd_theme' |
| 116 | +html_theme = "sphinx_rtd_theme" |
116 | 117 |
|
117 | 118 | # html_logo = "assets/logo.png" |
118 | 119 |
|
119 | 120 | # Theme options are theme-specific and customize the look and feel of a theme |
120 | 121 | # further. For a list of options available for each theme, see the |
121 | 122 | # documentation. |
122 | 123 | # |
123 | | -html_theme_options = {'logo_only': True} |
| 124 | +html_theme_options = {"logo_only": True} |
124 | 125 |
|
125 | 126 | # Add any paths that contain custom static files (such as style sheets) here, |
126 | 127 | # relative to this directory. They are copied after the builtin static files, |
127 | 128 | # so a file named "default.css" will overwrite the builtin "default.css". |
128 | | -#html_static_path = ['_static'] |
| 129 | +# html_static_path = ['_static'] |
129 | 130 |
|
130 | 131 | # Custom sidebar templates, must be a dictionary that maps document names |
131 | 132 | # to template names. |
|
140 | 141 | # -- Options for HTMLHelp output --------------------------------------------- |
141 | 142 |
|
142 | 143 | # Output file base name for HTML help builder. |
143 | | -htmlhelp_basename = project + 'doc' |
| 144 | +htmlhelp_basename = project + "doc" |
144 | 145 |
|
145 | 146 | # -- Options for LaTeX output ------------------------------------------------ |
146 | 147 |
|
147 | 148 | latex_elements = { |
148 | 149 | # The paper size ('letterpaper' or 'a4paper'). |
149 | 150 | # |
150 | 151 | # 'papersize': 'letterpaper', |
151 | | - |
152 | 152 | # The font size ('10pt', '11pt' or '12pt'). |
153 | 153 | # |
154 | 154 | # 'pointsize': '10pt', |
155 | | - |
156 | 155 | # Additional stuff for the LaTeX preamble. |
157 | 156 | # |
158 | 157 | # 'preamble': '', |
159 | | - |
160 | 158 | # Latex figure (float) alignment |
161 | 159 | # |
162 | 160 | # 'figure_align': 'htbp', |
|
166 | 164 | # (source start file, target name, title, |
167 | 165 | # author, documentclass [howto, manual, or own class]). |
168 | 166 | latex_documents = [ |
169 | | - (master_doc, project + '.tex', project + ' Documentation', author, |
170 | | - 'manual'), |
| 167 | + ( |
| 168 | + master_doc, |
| 169 | + project + ".tex", |
| 170 | + project + " Documentation", |
| 171 | + author, |
| 172 | + "manual", |
| 173 | + ), |
171 | 174 | ] |
172 | 175 |
|
173 | 176 | # -- Options for manual page output ------------------------------------------ |
174 | 177 |
|
175 | 178 | # One entry per manual page. List of tuples |
176 | 179 | # (source start file, name, description, authors, manual section). |
177 | | -man_pages = [(master_doc, project.lower(), project + ' Documentation', |
178 | | - [author], 1)] |
| 180 | +man_pages = [ |
| 181 | + (master_doc, project.lower(), project + " Documentation", [author], 1) |
| 182 | +] |
179 | 183 |
|
180 | 184 | # -- Options for Texinfo output ---------------------------------------------- |
181 | 185 |
|
182 | 186 | # Grouping the document tree into Texinfo files. List of tuples |
183 | 187 | # (source start file, target name, title, author, |
184 | 188 | # dir menu entry, description, category) |
185 | 189 | texinfo_documents = [ |
186 | | - (master_doc, project, project + ' Documentation', author, project, |
187 | | - 'One line description of project.', 'Miscellaneous'), |
| 190 | + ( |
| 191 | + master_doc, |
| 192 | + project, |
| 193 | + project + " Documentation", |
| 194 | + author, |
| 195 | + project, |
| 196 | + "One line description of project.", |
| 197 | + "Miscellaneous", |
| 198 | + ), |
188 | 199 | ] |
189 | 200 |
|
190 | 201 | # -- Extension configuration ------------------------------------------------- |
191 | 202 |
|
192 | 203 | # -- Options for intersphinx extension --------------------------------------- |
193 | 204 |
|
194 | 205 | # Example configuration for intersphinx: refer to the Python standard library. |
195 | | -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} |
| 206 | +intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} |
0 commit comments