|
24 | 24 |
|
25 | 25 | # -- Project information ----------------------------------------------------- |
26 | 26 |
|
27 | | -project = u'TensorWrapper' |
28 | | -copyright = u'2020, NWChemEx Team' |
29 | | -author = u'NWChemEx Team' |
| 27 | +project = "TensorWrapper" |
| 28 | +copyright = "2020, NWChemEx Team" |
| 29 | +author = "NWChemEx Team" |
30 | 30 |
|
31 | | -version = '1.0.0' |
| 31 | +version = "1.0.0" |
32 | 32 | # The full version, including alpha/beta/rc tags |
33 | 33 | release = version |
34 | 34 |
|
|
40 | 40 |
|
41 | 41 | # If your documentation needs a minimal Sphinx version, state it here. |
42 | 42 | # |
43 | | -needs_sphinx = '1.3' |
| 43 | +needs_sphinx = "1.3" |
44 | 44 |
|
45 | 45 | # Add any Sphinx extension module names here, as strings. They can be |
46 | 46 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
47 | 47 | # ones. |
48 | 48 | extensions = [ |
49 | | - 'sphinx.ext.autodoc', 'sphinx.ext.mathjax', 'sphinx.ext.githubpages', |
50 | | - 'sphinx.ext.autosummary', 'sphinx_rtd_theme', 'sphinxcontrib.bibtex' |
| 49 | + "sphinx.ext.autodoc", |
| 50 | + "sphinx.ext.mathjax", |
| 51 | + "sphinx.ext.githubpages", |
| 52 | + "sphinx.ext.autosummary", |
| 53 | + "sphinx_rtd_theme", |
| 54 | + "sphinxcontrib.bibtex", |
51 | 55 | ] |
52 | 56 | dir_path = os.path.dirname(os.path.realpath(__file__)) |
53 | 57 | doc_path = os.path.dirname(dir_path) |
54 | 58 | root_path = os.path.dirname(doc_path) |
55 | 59 |
|
56 | 60 | # Add any paths that contain templates here, relative to this directory. |
57 | | -#templates_path = ['_templates'] |
| 61 | +# templates_path = ['_templates'] |
58 | 62 |
|
59 | 63 | # The suffix(es) of source filenames. |
60 | 64 | # You can specify multiple suffix as a list of string: |
61 | 65 | # |
62 | 66 | # source_suffix = ['.rst', '.md'] |
63 | | -source_suffix = '.rst' |
| 67 | +source_suffix = ".rst" |
64 | 68 |
|
65 | 69 | # The master toctree document. |
66 | | -master_doc = 'index' |
| 70 | +master_doc = "index" |
67 | 71 |
|
68 | 72 | # The language for content autogenerated by Sphinx. Refer to documentation |
69 | 73 | # for a list of supported languages. |
70 | 74 | # |
71 | 75 | # This is also used if you do content translation via gettext catalogs. |
72 | 76 | # Usually you set "language" from the command line for these cases. |
73 | | -language = 'en' |
| 77 | +language = "en" |
74 | 78 |
|
75 | 79 | # List of patterns, relative to source directory, that match files and |
76 | 80 | # directories to ignore when looking for source files. |
77 | 81 | # This pattern also affects html_static_path and html_extra_path . |
78 | 82 | exclude_patterns = [] |
79 | 83 |
|
80 | 84 | # The name of the Pygments (syntax highlighting) style to use. |
81 | | -pygments_style = 'sphinx' |
| 85 | +pygments_style = "sphinx" |
82 | 86 |
|
83 | 87 | numfig = True |
84 | 88 |
|
|
87 | 91 | # The theme to use for HTML and HTML Help pages. See the documentation for |
88 | 92 | # a list of builtin themes. |
89 | 93 | # |
90 | | -html_theme = 'sphinx_rtd_theme' |
| 94 | +html_theme = "sphinx_rtd_theme" |
91 | 95 |
|
92 | 96 | html_logo = "assets/logo_candybar.png" |
93 | 97 |
|
94 | 98 | # Theme options are theme-specific and customize the look and feel of a theme |
95 | 99 | # further. For a list of options available for each theme, see the |
96 | 100 | # documentation. |
97 | 101 | # |
98 | | -html_theme_options = {'vcs_pageview_mode': 'edit', 'logo_only': True} |
| 102 | +html_theme_options = {"vcs_pageview_mode": "edit", "logo_only": True} |
99 | 103 |
|
100 | 104 | # Add any paths that contain custom static files (such as style sheets) here, |
101 | 105 | # relative to this directory. They are copied after the builtin static files, |
102 | 106 | # so a file named "default.css" will overwrite the builtin "default.css". |
103 | | -#html_static_path = ['_static'] |
| 107 | +# html_static_path = ['_static'] |
104 | 108 |
|
105 | 109 | # Custom sidebar templates, must be a dictionary that maps document names |
106 | 110 | # to template names. |
|
114 | 118 |
|
115 | 119 | # Allows the edit on GitHub button to make editing the docs easier. |
116 | 120 | html_context = { |
117 | | - 'display_github': True, |
118 | | - 'github_user': 'NWChemEx', |
119 | | - 'github_repo': 'TensorWrapper', |
120 | | - 'github_version': 'master/docs/source/', |
| 121 | + "display_github": True, |
| 122 | + "github_user": "NWChemEx", |
| 123 | + "github_repo": "TensorWrapper", |
| 124 | + "github_version": "master/docs/source/", |
121 | 125 | } |
122 | 126 |
|
123 | 127 | # -- Options for HTMLHelp output --------------------------------------------- |
124 | 128 |
|
125 | 129 | # Output file base name for HTML help builder. |
126 | | -htmlhelp_basename = project + 'doc' |
| 130 | +htmlhelp_basename = project + "doc" |
127 | 131 |
|
128 | 132 | # -- Options for LaTeX output ------------------------------------------------ |
129 | 133 |
|
130 | 134 | latex_elements = { |
131 | 135 | # The paper size ('letterpaper' or 'a4paper'). |
132 | 136 | # |
133 | 137 | # 'papersize': 'letterpaper', |
134 | | - |
135 | 138 | # The font size ('10pt', '11pt' or '12pt'). |
136 | 139 | # |
137 | 140 | # 'pointsize': '10pt', |
138 | | - |
139 | 141 | # Additional stuff for the LaTeX preamble. |
140 | 142 | # |
141 | 143 | # 'preamble': '', |
142 | | - |
143 | 144 | # Latex figure (float) alignment |
144 | 145 | # |
145 | 146 | # 'figure_align': 'htbp', |
|
149 | 150 | # (source start file, target name, title, |
150 | 151 | # author, documentclass [howto, manual, or own class]). |
151 | 152 | latex_documents = [ |
152 | | - (master_doc, project + '.tex', project + ' Documentation', author, |
153 | | - 'manual'), |
| 153 | + ( |
| 154 | + master_doc, |
| 155 | + project + ".tex", |
| 156 | + project + " Documentation", |
| 157 | + author, |
| 158 | + "manual", |
| 159 | + ), |
154 | 160 | ] |
155 | 161 |
|
156 | 162 | # -- Extension configuration ------------------------------------------------- |
157 | 163 |
|
158 | 164 | # -- Options for intersphinx extension --------------------------------------- |
159 | 165 |
|
160 | 166 | # Example configuration for intersphinx: refer to the Python standard library. |
161 | | -intersphinx_mapping = {'https://docs.python.org/': None} |
| 167 | +intersphinx_mapping = {"https://docs.python.org/": None} |
162 | 168 |
|
163 | 169 | # -- Options for bibtex -------------------------------------------------------- |
164 | 170 |
|
165 | 171 | bibtex_bibfiles = [ |
166 | | - 'bibliography/background.bib', 'bibliography/other_libraries.bib' |
| 172 | + "bibliography/background.bib", |
| 173 | + "bibliography/other_libraries.bib", |
167 | 174 | ] |
168 | | -bibtex_reference_style = 'super' |
169 | | -bibtex_default_style = 'plain' |
| 175 | +bibtex_reference_style = "super" |
| 176 | +bibtex_default_style = "plain" |
0 commit comments