Skip to content

Commit

Permalink
fix the linter
Browse files Browse the repository at this point in the history
  • Loading branch information
fchapoton committed Feb 3, 2024
1 parent 39f1722 commit 9e7a585
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions src/sage_docbuild/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@

jupyter_execute_default_kernel = 'sagemath'

if os.environ.get('SAGE_LIVE_DOC', 'no') == 'yes':
if os.environ.get('SAGE_LIVE_DOC', 'no') == 'yes':
SAGE_JUPYTER_SERVER = os.environ.get('SAGE_JUPYTER_SERVER', 'binder')
if SAGE_JUPYTER_SERVER.startswith('binder'):
# format: "binder" or
Expand Down Expand Up @@ -197,17 +197,17 @@ def sphinx_plot(graphics, **kwds):

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

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

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

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

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

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

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

app.config.intersphinx_mapping = {
'python': ('https://docs.python.org/',
os.path.join(SAGE_DOC_SRC, "common",
"python{}.inv".format(python_version))),
'python': ('https://docs.python.org/',
os.path.join(SAGE_DOC_SRC, "common",
"python{}.inv".format(python_version))),
}
if PPLPY_DOCS and os.path.exists(os.path.join(PPLPY_DOCS, 'objects.inv')):
app.config.intersphinx_mapping['pplpy'] = (PPLPY_DOCS, None)
Expand Down Expand Up @@ -379,18 +379,18 @@ def set_intersphinx_mappings(app, config):
html_theme_options = {}

# HTML style sheet. This overrides a HTML theme's corresponding setting.
#html_style = 'default.css'
# html_style = 'default.css'

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

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

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

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

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_use_modindex = True
# html_use_modindex = True

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

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


# This replaces the setup() in sage.misc.sagedoc_conf
def setup(app):
app.connect('autodoc-process-docstring', process_docstring_cython)
Expand Down

0 comments on commit 9e7a585

Please sign in to comment.