|
1 | | -# -*- coding: utf-8 -*- |
2 | 1 | # |
3 | 2 | # Configuration file for the Sphinx documentation builder. |
4 | 3 | # |
|
14 | 13 | # If extensions (or modules to document with autodoc) are in another directory, |
15 | 14 | # add these directories to sys.path here. If the directory is relative to the |
16 | 15 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
17 | | -sys.path.append(os.path.join(os.path.dirname(__file__), '..')) |
| 16 | +sys.path.append(os.path.join(os.path.dirname(__file__), "..")) |
18 | 17 |
|
19 | 18 | # -- Project information ----------------------------------------------------- |
20 | 19 |
|
21 | | -project = u'ATIP' |
22 | | -copyright = u'2019, Tobyn Nicholls' |
23 | | -author = u'Tobyn Nicholls' |
| 20 | +project = "ATIP" |
| 21 | +copyright = "2019, Tobyn Nicholls" |
| 22 | +author = "Tobyn Nicholls" |
24 | 23 |
|
25 | 24 | # The short X.Y version |
26 | | -version = u'1.0' |
| 25 | +version = "1.0" |
27 | 26 | # The full version, including alpha/beta/rc tags |
28 | | -release = u'1.0' |
| 27 | +release = "1.0" |
29 | 28 |
|
30 | 29 |
|
31 | 30 | # -- General configuration --------------------------------------------------- |
|
38 | 37 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
39 | 38 | # ones. |
40 | 39 | extensions = [ |
41 | | - 'sphinx.ext.autodoc', |
42 | | - 'sphinx.ext.intersphinx', |
43 | | - 'sphinx.ext.napoleon', |
44 | | - 'sphinx.ext.viewcode', |
| 40 | + "sphinx.ext.autodoc", |
| 41 | + "sphinx.ext.intersphinx", |
| 42 | + "sphinx.ext.napoleon", |
| 43 | + "sphinx.ext.viewcode", |
45 | 44 | ] |
46 | 45 |
|
47 | 46 | # Include both class and __init__() docstrings. |
48 | | -autoclass_content = 'both' |
| 47 | +autoclass_content = "both" |
49 | 48 |
|
50 | 49 | # Add any paths that contain templates here, relative to this directory. |
51 | | -templates_path = ['_templates'] |
| 50 | +templates_path = ["_templates"] |
52 | 51 |
|
53 | 52 | # The suffix(es) of source filenames. |
54 | 53 | # You can specify multiple suffix as a list of string: |
55 | 54 | # |
56 | 55 | # source_suffix = ['.rst', '.md'] |
57 | | -source_suffix = '.rst' |
| 56 | +source_suffix = ".rst" |
58 | 57 |
|
59 | 58 | # The master toctree document. |
60 | | -master_doc = 'index' |
| 59 | +master_doc = "index" |
61 | 60 |
|
62 | 61 | # The language for content autogenerated by Sphinx. Refer to documentation |
63 | 62 | # for a list of supported languages. |
64 | 63 | # |
65 | 64 | # This is also used if you do content translation via gettext catalogs. |
66 | 65 | # Usually you set "language" from the command line for these cases. |
67 | | -language = 'en' |
| 66 | +language = "en" |
68 | 67 |
|
69 | 68 | # List of patterns, relative to source directory, that match files and |
70 | 69 | # directories to ignore when looking for source files. |
71 | 70 | # This pattern also affects html_static_path and html_extra_path. |
72 | | -exclude_patterns = ['_build'] |
| 71 | +exclude_patterns = ["_build"] |
73 | 72 |
|
74 | 73 | # The name of the Pygments (syntax highlighting) style to use. |
75 | | -pygments_style = 'sphinx' |
| 74 | +pygments_style = "sphinx" |
76 | 75 |
|
77 | 76 |
|
78 | 77 | # -- Options for HTML output ------------------------------------------------- |
79 | 78 |
|
80 | 79 | # The theme to use for HTML and HTML Help pages. See the documentation for |
81 | 80 | # a list of builtin themes. |
82 | 81 | # |
83 | | -html_theme = 'sphinx_rtd_theme' |
| 82 | +html_theme = "sphinx_rtd_theme" |
84 | 83 |
|
85 | 84 | # Theme options are theme-specific and customize the look and feel of a theme |
86 | 85 | # further. For a list of options available for each theme, see the |
|
91 | 90 | # Add any paths that contain custom static files (such as style sheets) here, |
92 | 91 | # relative to this directory. They are copied after the builtin static files, |
93 | 92 | # so a file named "default.css" will overwrite the builtin "default.css". |
94 | | -#html_static_path = ['_static'] |
| 93 | +# html_static_path = ['_static'] |
95 | 94 |
|
96 | 95 | # Custom sidebar templates, must be a dictionary that maps document names |
97 | 96 | # to template names. |
|
107 | 106 | # -- Options for HTMLHelp output --------------------------------------------- |
108 | 107 |
|
109 | 108 | # Output file base name for HTML help builder. |
110 | | -htmlhelp_basename = 'docsdoc' |
| 109 | +htmlhelp_basename = "docsdoc" |
111 | 110 |
|
112 | 111 |
|
113 | 112 | # -- Options for LaTeX output ------------------------------------------------ |
|
116 | 115 | # The paper size ('letterpaper' or 'a4paper'). |
117 | 116 | # |
118 | 117 | # 'papersize': 'letterpaper', |
119 | | - |
120 | 118 | # The font size ('10pt', '11pt' or '12pt'). |
121 | 119 | # |
122 | 120 | # 'pointsize': '10pt', |
123 | | - |
124 | 121 | # Additional stuff for the LaTeX preamble. |
125 | 122 | # |
126 | 123 | # 'preamble': '', |
127 | | - |
128 | 124 | # Latex figure (float) alignment |
129 | 125 | # |
130 | 126 | # 'figure_align': 'htbp', |
|
134 | 130 | # (source start file, target name, title, |
135 | 131 | # author, documentclass [howto, manual, or own class]). |
136 | 132 | latex_documents = [ |
137 | | - (master_doc, 'docs.tex', u'ATIP Documentation', |
138 | | - u'Tobyn Nicholls', 'manual'), |
| 133 | + (master_doc, "docs.tex", "ATIP Documentation", "Tobyn Nicholls", "manual"), |
139 | 134 | ] |
140 | 135 |
|
141 | 136 |
|
142 | 137 | # -- Options for manual page output ------------------------------------------ |
143 | 138 |
|
144 | 139 | # One entry per manual page. List of tuples |
145 | 140 | # (source start file, name, description, authors, manual section). |
146 | | -man_pages = [ |
147 | | - (master_doc, 'docs', u'ATIP Documentation', |
148 | | - [author], 1) |
149 | | -] |
| 141 | +man_pages = [(master_doc, "docs", "ATIP Documentation", [author], 1)] |
150 | 142 |
|
151 | 143 |
|
152 | 144 | # -- Options for Texinfo output ---------------------------------------------- |
|
155 | 147 | # (source start file, target name, title, author, |
156 | 148 | # dir menu entry, description, category) |
157 | 149 | texinfo_documents = [ |
158 | | - (master_doc, 'docs', u'ATIP Documentation', |
159 | | - author, 'docs', 'ATIP - Accelerator Toolbox Interface for Pytac.', |
160 | | - 'Accelerator Physics'), |
| 150 | + ( |
| 151 | + master_doc, |
| 152 | + "docs", |
| 153 | + "ATIP Documentation", |
| 154 | + author, |
| 155 | + "docs", |
| 156 | + "ATIP - Accelerator Toolbox Interface for Pytac.", |
| 157 | + "Accelerator Physics", |
| 158 | + ), |
161 | 159 | ] |
162 | 160 |
|
163 | 161 |
|
|
176 | 174 | # epub_uid = '' |
177 | 175 |
|
178 | 176 | # A list of files that should not be packed into the epub file. |
179 | | -epub_exclude_files = ['search.html'] |
| 177 | +epub_exclude_files = ["search.html"] |
180 | 178 |
|
181 | 179 |
|
182 | 180 | # -- Extension configuration ------------------------------------------------- |
|
185 | 183 |
|
186 | 184 | # Example configuration for intersphinx: refer to the Python standard library. |
187 | 185 | intersphinx_mapping = { |
188 | | - 'python': ('https://docs.python.org/', None), |
189 | | - 'pytac': ('https://pytac.readthedocs.io/en/latest/', None), |
190 | | - 'cothread': ('https://cothread.readthedocs.io/en/latest/', None) |
| 186 | + "python": ("https://docs.python.org/", None), |
| 187 | + "pytac": ("https://pytac.readthedocs.io/en/latest/", None), |
| 188 | + "cothread": ("https://cothread.readthedocs.io/en/latest/", None), |
191 | 189 | } |
0 commit comments