|
19 | 19 | # If extensions (or modules to document with autodoc) are in another directory,
|
20 | 20 | # add these directories to sys.path here. If the directory is relative to the
|
21 | 21 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
22 |
| -#sys.path.insert(0, os.path.abspath('.')) |
23 |
| -sys.path.insert(0, os.path.abspath('../../..')) |
| 22 | +# sys.path.insert(0, os.path.abspath('.')) |
| 23 | +sys.path.insert(0, os.path.abspath("../../..")) |
24 | 24 |
|
25 | 25 | # abbreviations
|
26 |
| -ab_authors = u'Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group' |
| 26 | +ab_authors = "Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group" |
27 | 27 |
|
28 | 28 | # -- General configuration -----------------------------------------------------
|
29 | 29 |
|
|
33 | 33 | # Add any Sphinx extension module names here, as strings. They can be extensions
|
34 | 34 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
35 | 35 | extensions = [
|
36 |
| - 'sphinx.ext.autodoc', |
37 |
| - 'sphinx.ext.coverage', |
38 |
| - 'sphinx.ext.napoleon', |
39 |
| - 'sphinx.ext.intersphinx', |
40 |
| - 'm2r', |
| 36 | + "sphinx.ext.autodoc", |
| 37 | + "sphinx.ext.coverage", |
| 38 | + "sphinx.ext.napoleon", |
| 39 | + "sphinx.ext.intersphinx", |
| 40 | + "m2r", |
41 | 41 | ]
|
42 | 42 |
|
43 | 43 | # Add any paths that contain templates here, relative to this directory.
|
44 |
| -templates_path = ['_templates'] |
| 44 | +templates_path = ["_templates"] |
45 | 45 |
|
46 | 46 | # The suffix(es) of source filenames.
|
47 | 47 | # You can specify multiple suffix as a list of string:
|
48 | 48 | #
|
49 |
| -source_suffix = ['.rst', '.md'] |
| 49 | +source_suffix = [".rst", ".md"] |
50 | 50 |
|
51 | 51 | # The encoding of source files.
|
52 | 52 | # source_encoding = 'utf-8-sig'
|
53 | 53 |
|
54 | 54 | # The master toctree document.
|
55 |
| -master_doc = 'index' |
| 55 | +master_doc = "index" |
56 | 56 |
|
57 | 57 | # General information about the project.
|
58 |
| -project = 'diffpy.srreal' |
59 |
| -copyright = '%Y, Brookhaven National Laboratory' |
| 58 | +project = "diffpy.srreal" |
| 59 | +copyright = "%Y, Brookhaven National Laboratory" |
60 | 60 |
|
61 | 61 | # The version info for the project you're documenting, acts as replacement for
|
62 | 62 | # |version| and |release|, also used in various other places throughout the
|
63 | 63 | # built documents.
|
64 | 64 | from setup import versiondata
|
65 |
| -fullversion = versiondata.get('DEFAULT', 'version') |
| 65 | + |
| 66 | +fullversion = versiondata.get("DEFAULT", "version") |
66 | 67 | # The short X.Y version.
|
67 |
| -version = ''.join(fullversion.split('.post')[:1]) |
| 68 | +version = "".join(fullversion.split(".post")[:1]) |
68 | 69 | # The full version, including alpha/beta/rc tags.
|
69 | 70 | release = fullversion
|
70 | 71 |
|
|
75 | 76 | # There are two options for replacing |today|: either, you set today to some
|
76 | 77 | # non-false value, then it is used:
|
77 | 78 | # today = ''
|
78 |
| -today_seconds = versiondata.getint('DEFAULT', 'timestamp') |
79 |
| -today = time.strftime('%B %d, %Y', time.localtime(today_seconds)) |
| 79 | +today_seconds = versiondata.getint("DEFAULT", "timestamp") |
| 80 | +today = time.strftime("%B %d, %Y", time.localtime(today_seconds)) |
80 | 81 | year = today.split()[-1]
|
81 | 82 | # Else, today_fmt is used as the format for a strftime call.
|
82 | 83 | # today_fmt = '%B %d, %Y'
|
83 | 84 | # substitute YEAR in the copyright string
|
84 |
| -copyright = copyright.replace('%Y', year) |
| 85 | +copyright = copyright.replace("%Y", year) |
85 | 86 |
|
86 | 87 | # List of patterns, relative to source directory, that match files and
|
87 | 88 | # directories to ignore when looking for source files.
|
|
102 | 103 | # show_authors = False
|
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 | # A list of ignored prefixes for module index sorting.
|
108 |
| -modindex_common_prefix = ['diffpy.srreal'] |
| 109 | +modindex_common_prefix = ["diffpy.srreal"] |
109 | 110 |
|
110 | 111 | # Display all warnings for missing links.
|
111 | 112 | nitpicky = True
|
|
114 | 115 |
|
115 | 116 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
116 | 117 | # a list of builtin themes.
|
117 |
| -html_theme = 'sphinx_py3doc_enhanced_theme' |
| 118 | +html_theme = "sphinx_py3doc_enhanced_theme" |
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 | html_theme_options = {
|
123 |
| - 'collapsiblesidebar' : 'true', |
124 |
| - 'navigation_with_keys' : 'true', |
| 124 | + "collapsiblesidebar": "true", |
| 125 | + "navigation_with_keys": "true", |
125 | 126 | }
|
126 | 127 |
|
127 | 128 | # Add any paths that contain custom themes here, relative to this directory.
|
|
190 | 191 | # html_file_suffix = None
|
191 | 192 |
|
192 | 193 | # Output file base name for HTML help builder.
|
193 |
| -htmlhelp_basename = 'srrealdoc' |
| 194 | +htmlhelp_basename = "srrealdoc" |
194 | 195 |
|
195 | 196 |
|
196 | 197 | # -- Options for LaTeX output --------------------------------------------------
|
197 | 198 |
|
198 | 199 | latex_elements = {
|
199 |
| -# The paper size ('letterpaper' or 'a4paper'). |
200 |
| -# 'papersize': 'letterpaper', |
201 |
| - |
202 |
| -# The font size ('10pt', '11pt' or '12pt'). |
203 |
| -# 'pointsize': '10pt', |
204 |
| - |
205 |
| -# Additional stuff for the LaTeX preamble. |
206 |
| -# 'preamble': '', |
| 200 | + # The paper size ('letterpaper' or 'a4paper'). |
| 201 | + # 'papersize': 'letterpaper', |
| 202 | + # The font size ('10pt', '11pt' or '12pt'). |
| 203 | + # 'pointsize': '10pt', |
| 204 | + # Additional stuff for the LaTeX preamble. |
| 205 | + # 'preamble': '', |
207 | 206 | }
|
208 | 207 |
|
209 | 208 | # Grouping the document tree into LaTeX files. List of tuples
|
210 | 209 | # (source start file, target name, title, author, documentclass [howto/manual]).
|
211 | 210 | latex_documents = [
|
212 |
| - ('index', 'diffpy.srreal.tex', 'diffpy.srreal Documentation', |
213 |
| - ab_authors, 'manual'), |
| 211 | + ("index", "diffpy.srreal.tex", "diffpy.srreal Documentation", ab_authors, "manual"), |
214 | 212 | ]
|
215 | 213 |
|
216 | 214 | # The name of an image file (relative to this directory) to place at the top of
|
|
238 | 236 |
|
239 | 237 | # One entry per manual page. List of tuples
|
240 | 238 | # (source start file, name, description, authors, manual section).
|
241 |
| -man_pages = [ |
242 |
| - ('index', 'diffpy.srreal', 'diffpy.srreal Documentation', |
243 |
| - ab_authors, 1) |
244 |
| -] |
| 239 | +man_pages = [("index", "diffpy.srreal", "diffpy.srreal Documentation", ab_authors, 1)] |
245 | 240 |
|
246 | 241 | # If true, show URL addresses after external links.
|
247 | 242 | # man_show_urls = False
|
|
253 | 248 | # (source start file, target name, title, author,
|
254 | 249 | # dir menu entry, description, category)
|
255 | 250 | texinfo_documents = [
|
256 |
| - ('index', 'diffpy.srreal', 'diffpy.srreal Documentation', |
257 |
| - ab_authors, 'diffpy.srreal', 'One line description of project.', |
258 |
| - 'Miscellaneous'), |
| 251 | + ( |
| 252 | + "index", |
| 253 | + "diffpy.srreal", |
| 254 | + "diffpy.srreal Documentation", |
| 255 | + ab_authors, |
| 256 | + "diffpy.srreal", |
| 257 | + "One line description of project.", |
| 258 | + "Miscellaneous", |
| 259 | + ), |
259 | 260 | ]
|
260 | 261 |
|
261 | 262 | # Documents to append as an appendix to all manuals.
|
|
270 | 271 |
|
271 | 272 | # Example configuration for intersphinx: refer to the Python standard library.
|
272 | 273 | intersphinx_mapping = {
|
273 |
| - 'numpy': ('https://docs.scipy.org/doc/numpy', None), |
274 |
| - 'python' : ('https://docs.python.org/3.7', None), |
| 274 | + "numpy": ("https://docs.scipy.org/doc/numpy", None), |
| 275 | + "python": ("https://docs.python.org/3.7", None), |
275 | 276 | }
|
0 commit comments