Skip to content

Commit 9e7a585

Browse files
committed
fix the linter
1 parent 39f1722 commit 9e7a585

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

src/sage_docbuild/conf.py

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757

5858
jupyter_execute_default_kernel = 'sagemath'
5959

60-
if os.environ.get('SAGE_LIVE_DOC', 'no') == 'yes':
60+
if os.environ.get('SAGE_LIVE_DOC', 'no') == 'yes':
6161
SAGE_JUPYTER_SERVER = os.environ.get('SAGE_JUPYTER_SERVER', 'binder')
6262
if SAGE_JUPYTER_SERVER.startswith('binder'):
6363
# format: "binder" or
@@ -197,17 +197,17 @@ def sphinx_plot(graphics, **kwds):
197197

198198
# The language for content autogenerated by Sphinx. Refer to documentation
199199
# for a list of supported languages.
200-
#language = None
200+
# language = None
201201

202202
# The LaTeX engine to build the docs.
203203
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-latex_engine
204204
latex_engine = 'lualatex'
205205

206206
# There are two options for replacing |today|: either, you set today to some
207207
# non-false value, then it is used:
208-
#today = ''
208+
# today = ''
209209
# Else, today_fmt is used as the format for a strftime call.
210-
#today_fmt = '%B %d, %Y'
210+
# today_fmt = '%B %d, %Y'
211211

212212
# List of glob-style patterns that should be excluded when looking for
213213
# source files. [1] They are matched against the source file names
@@ -216,11 +216,11 @@ def sphinx_plot(graphics, **kwds):
216216
exclude_patterns = ['.build']
217217

218218
# If true, '()' will be appended to :func: etc. cross-reference text.
219-
#add_function_parentheses = True
219+
# add_function_parentheses = True
220220

221221
# If true, the current module name will be prepended to all description
222222
# unit titles (such as .. function::).
223-
#add_module_names = True
223+
# add_module_names = True
224224

225225
# If true, sectionauthor and moduleauthor directives will be shown in the
226226
# output. They are ignored by default.
@@ -274,9 +274,9 @@ def set_intersphinx_mappings(app, config):
274274
return
275275

276276
app.config.intersphinx_mapping = {
277-
'python': ('https://docs.python.org/',
278-
os.path.join(SAGE_DOC_SRC, "common",
279-
"python{}.inv".format(python_version))),
277+
'python': ('https://docs.python.org/',
278+
os.path.join(SAGE_DOC_SRC, "common",
279+
"python{}.inv".format(python_version))),
280280
}
281281
if PPLPY_DOCS and os.path.exists(os.path.join(PPLPY_DOCS, 'objects.inv')):
282282
app.config.intersphinx_mapping['pplpy'] = (PPLPY_DOCS, None)
@@ -379,18 +379,18 @@ def set_intersphinx_mappings(app, config):
379379
html_theme_options = {}
380380

381381
# HTML style sheet. This overrides a HTML theme's corresponding setting.
382-
#html_style = 'default.css'
382+
# html_style = 'default.css'
383383

384384
# The name for this set of Sphinx documents. If None, it defaults to
385385
# "<project> v<release> documentation".
386-
#html_title = None
386+
# html_title = None
387387

388388
# A shorter title for the navigation bar. Default is the same as html_title.
389-
#html_short_title = None
389+
# html_short_title = None
390390

391391
# The name of an image file (within the static path) to place at the top of
392392
# the sidebar.
393-
#html_logo = 'sagelogo-word.ico'
393+
# html_logo = 'sagelogo-word.ico'
394394

395395
# The name of an image file (within the static path) to use as favicon of the
396396
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -439,17 +439,17 @@ def set_intersphinx_mappings(app, config):
439439

440440
# If true, SmartyPants will be used to convert quotes and dashes to
441441
# typographically correct entities.
442-
#html_use_smartypants = True
442+
# html_use_smartypants = True
443443

444444
# Custom sidebar templates, maps document names to template names.
445-
#html_sidebars = {}
445+
# html_sidebars = {}
446446

447447
# Additional templates that should be rendered to pages, maps page names to
448448
# template names.
449-
#html_additional_pages = {}
449+
# html_additional_pages = {}
450450

451451
# If false, no module index is generated.
452-
#html_use_modindex = True
452+
# html_use_modindex = True
453453

454454
# A list of prefixes that are ignored for sorting the Python module index ( if
455455
# this is set to ['foo.'], then foo.bar is shown under B, not F). Works only
@@ -852,6 +852,7 @@ def apply(self):
852852

853853
node.parent.insert(node.parent.index(node) + 1, cell_node)
854854

855+
855856
# This replaces the setup() in sage.misc.sagedoc_conf
856857
def setup(app):
857858
app.connect('autodoc-process-docstring', process_docstring_cython)

0 commit comments

Comments
 (0)