|
34 | 34 | # Add any Sphinx extension module names here, as strings. They can be
|
35 | 35 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
36 | 36 | # ones.
|
37 |
| -extensions = ['sphinx.ext.autodoc', |
38 |
| - 'sphinx.ext.doctest', |
39 |
| - 'sphinx.ext.intersphinx', |
40 |
| - 'sphinx.ext.coverage', |
41 |
| - 'sphinx.ext.githubpages'] |
| 37 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.coverage", "sphinx.ext.githubpages"] |
42 | 38 |
|
43 | 39 | # Add any paths that contain templates here, relative to this directory.
|
44 |
| -templates_path = ['_templates'] |
| 40 | +templates_path = ["_templates"] |
45 | 41 |
|
46 | 42 | # The suffix(es) of source filenames.
|
47 | 43 | # You can specify multiple suffix as a list of string:
|
48 | 44 | #
|
49 | 45 | # source_suffix = ['.rst', '.md']
|
50 |
| -source_suffix = '.rst' |
| 46 | +source_suffix = ".rst" |
51 | 47 |
|
52 | 48 | # The master toctree document.
|
53 |
| -master_doc = 'index' |
| 49 | +master_doc = "index" |
54 | 50 |
|
55 | 51 | # General information about the project.
|
56 |
| -project = 'pycarl' |
57 |
| -copyright = 'MOVES RWTH Aachen' |
58 |
| -author = 'Sebastian Junges, Matthias Volk' |
| 52 | +project = "pycarl" |
| 53 | +copyright = "MOVES RWTH Aachen" |
| 54 | +author = "Sebastian Junges, Matthias Volk" |
59 | 55 |
|
60 | 56 | # The version info for the project you're documenting, acts as replacement for
|
61 | 57 | # |version| and |release|, also used in various other places throughout the
|
|
79 | 75 | exclude_patterns = []
|
80 | 76 |
|
81 | 77 | # The name of the Pygments (syntax highlighting) style to use.
|
82 |
| -pygments_style = 'sphinx' |
| 78 | +pygments_style = "sphinx" |
83 | 79 |
|
84 | 80 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
85 | 81 | todo_include_todos = False
|
|
90 | 86 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
91 | 87 | # a list of builtin themes.
|
92 | 88 | #
|
93 |
| -html_theme = 'bootstrap' |
| 89 | +html_theme = "bootstrap" |
94 | 90 |
|
95 | 91 | html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
|
96 | 92 |
|
|
101 | 97 |
|
102 | 98 | html_theme_options = {
|
103 | 99 | # Navigation bar title. (Default: ``project`` value)
|
104 |
| - 'navbar_title': "Pycarl", |
105 |
| - |
| 100 | + "navbar_title": "Pycarl", |
106 | 101 | # Tab name for entire site. (Default: "Site")
|
107 |
| - 'navbar_site_name': "Pycarl", |
108 |
| - |
| 102 | + "navbar_site_name": "Pycarl", |
109 | 103 | # A list of tuples containing pages or urls to link to.
|
110 | 104 | # Valid tuples should be in the following forms:
|
111 | 105 | # (name, page) # a link to a page
|
112 | 106 | # (name, "/aa/bb", 1) # a link to an arbitrary relative url
|
113 | 107 | # (name, "http://example.com", True) # arbitrary absolute url
|
114 | 108 | # Note the "1" or "True" value above as the third argument to indicate
|
115 | 109 | # an arbitrary url.
|
116 |
| - 'navbar_links': [ |
117 |
| - ("Carl", "https://github.com/moves-rwth/carl-storm", True), |
118 |
| - ("Github", "https://github.com/moves-rwth/pycarl", True) |
119 |
| - ], |
120 |
| - |
| 110 | + "navbar_links": [("Carl", "https://github.com/moves-rwth/carl-storm", True), ("Github", "https://github.com/moves-rwth/pycarl", True)], |
121 | 111 | # Render the next and previous page links in navbar. (Default: true)
|
122 |
| - 'navbar_sidebarrel': True, |
123 |
| - |
| 112 | + "navbar_sidebarrel": True, |
124 | 113 | # Render the current pages TOC in the navbar. (Default: true)
|
125 |
| - 'navbar_pagenav': True, |
126 |
| - |
| 114 | + "navbar_pagenav": True, |
127 | 115 | # Tab name for the current pages TOC. (Default: "Page")
|
128 |
| - 'navbar_pagenav_name': "Page", |
129 |
| - |
| 116 | + "navbar_pagenav_name": "Page", |
130 | 117 | # Global TOC depth for "site" navbar tab. (Default: 1)
|
131 | 118 | # Switching to -1 shows all levels.
|
132 |
| - 'globaltoc_depth': 2, |
133 |
| - |
| 119 | + "globaltoc_depth": 2, |
134 | 120 | # Include hidden TOCs in Site navbar?
|
135 | 121 | #
|
136 | 122 | # Note: If this is "false", you cannot have mixed ``:hidden:`` and
|
137 | 123 | # non-hidden ``toctree`` directives in the same page, or else the build
|
138 | 124 | # will break.
|
139 | 125 | #
|
140 | 126 | # Values: "true" (default) or "false"
|
141 |
| - 'globaltoc_includehidden': "true", |
142 |
| - |
| 127 | + "globaltoc_includehidden": "true", |
143 | 128 | # HTML navbar class (Default: "navbar") to attach to <div> element.
|
144 | 129 | # For black navbar, do "navbar navbar-inverse"
|
145 |
| - 'navbar_class': "navbar navbar-inverse", |
146 |
| - |
| 130 | + "navbar_class": "navbar navbar-inverse", |
147 | 131 | # Fix navigation bar to top of page?
|
148 | 132 | # Values: "true" (default) or "false"
|
149 |
| - 'navbar_fixed_top': "true", |
150 |
| - |
| 133 | + "navbar_fixed_top": "true", |
151 | 134 | # Location of link to source.
|
152 | 135 | # Options are "nav" (default), "footer" or anything else to exclude.
|
153 |
| - 'source_link_position': "footer", |
154 |
| - |
| 136 | + "source_link_position": "footer", |
155 | 137 | # Bootswatch (http://bootswatch.com/) theme.
|
156 | 138 | #
|
157 | 139 | # Options are nothing (default) or the name of a valid theme
|
158 | 140 | # such as "cosmo" or "sandstone".
|
159 |
| - 'bootswatch_theme': "united", |
160 |
| - |
| 141 | + "bootswatch_theme": "united", |
161 | 142 | # Choose Bootstrap version.
|
162 | 143 | # Values: "3" (default) or "2" (in quotes)
|
163 |
| - 'bootstrap_version': "3", |
| 144 | + "bootstrap_version": "3", |
164 | 145 | }
|
165 | 146 |
|
166 | 147 | # Add any paths that contain custom static files (such as style sheets) here,
|
167 | 148 | # relative to this directory. They are copied after the builtin static files,
|
168 | 149 | # so a file named "default.css" will overwrite the builtin "default.css".
|
169 |
| -html_static_path = ['_static'] |
| 150 | +html_static_path = ["_static"] |
170 | 151 |
|
171 | 152 |
|
172 | 153 | # -- Options for HTMLHelp output ------------------------------------------
|
173 | 154 |
|
174 | 155 | # Output file base name for HTML help builder.
|
175 |
| -htmlhelp_basename = 'pycarldoc' |
| 156 | +htmlhelp_basename = "pycarldoc" |
176 | 157 |
|
177 | 158 |
|
178 | 159 | # -- Options for LaTeX output ---------------------------------------------
|
|
181 | 162 | # The paper size ('letterpaper' or 'a4paper').
|
182 | 163 | #
|
183 | 164 | # 'papersize': 'letterpaper',
|
184 |
| - |
185 | 165 | # The font size ('10pt', '11pt' or '12pt').
|
186 | 166 | #
|
187 | 167 | # 'pointsize': '10pt',
|
188 |
| - |
189 | 168 | # Additional stuff for the LaTeX preamble.
|
190 | 169 | #
|
191 | 170 | # 'preamble': '',
|
192 |
| - |
193 | 171 | # Latex figure (float) alignment
|
194 | 172 | #
|
195 | 173 | # 'figure_align': 'htbp',
|
|
199 | 177 | # (source start file, target name, title,
|
200 | 178 | # author, documentclass [howto, manual, or own class]).
|
201 | 179 | latex_documents = [
|
202 |
| - (master_doc, 'pycarl.tex', 'pycarl Documentation', |
203 |
| - 'Sebastian Junges, Matthias Volk', 'manual'), |
| 180 | + (master_doc, "pycarl.tex", "pycarl Documentation", "Sebastian Junges, Matthias Volk", "manual"), |
204 | 181 | ]
|
205 | 182 |
|
206 | 183 |
|
207 | 184 | # -- Options for manual page output ---------------------------------------
|
208 | 185 |
|
209 | 186 | # One entry per manual page. List of tuples
|
210 | 187 | # (source start file, name, description, authors, manual section).
|
211 |
| -man_pages = [ |
212 |
| - (master_doc, 'pycarl', 'pycarl Documentation', |
213 |
| - [author], 1) |
214 |
| -] |
| 188 | +man_pages = [(master_doc, "pycarl", "pycarl Documentation", [author], 1)] |
215 | 189 |
|
216 | 190 |
|
217 | 191 | # -- Options for Texinfo output -------------------------------------------
|
|
220 | 194 | # (source start file, target name, title, author,
|
221 | 195 | # dir menu entry, description, category)
|
222 | 196 | texinfo_documents = [
|
223 |
| - (master_doc, 'pycarl', 'pycarl Documentation', |
224 |
| - author, 'pycarl', 'One line description of project.', |
225 |
| - 'Miscellaneous'), |
| 197 | + (master_doc, "pycarl", "pycarl Documentation", author, "pycarl", "One line description of project.", "Miscellaneous"), |
226 | 198 | ]
|
227 |
| - |
228 |
| - |
229 |
| - |
0 commit comments