mirror of
https://github.com/jupyter/docker-stacks.git
synced 2025-10-07 18:14:05 +00:00
pre-commit: run black autoformatter on all files
This commit is contained in:

committed by
Erik Sundell

parent
a99a182940
commit
fe3968efe0
92
docs/conf.py
92
docs/conf.py
@@ -25,40 +25,37 @@
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
needs_sphinx = '2.1'
|
||||
needs_sphinx = "2.1"
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'myst_parser',
|
||||
'sphinx_copybutton'
|
||||
]
|
||||
extensions = ["myst_parser", "sphinx_copybutton"]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
templates_path = ["_templates"]
|
||||
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
'.md': 'markdown',
|
||||
".rst": "restructuredtext",
|
||||
".md": "markdown",
|
||||
}
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = "index"
|
||||
|
||||
# General information about the project.
|
||||
project = 'docker-stacks'
|
||||
copyright = '2018- Project Jupyter'
|
||||
author = 'Project Jupyter'
|
||||
project = "docker-stacks"
|
||||
copyright = "2018- Project Jupyter"
|
||||
author = "Project Jupyter"
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = 'latest'
|
||||
version = "latest"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = 'latest'
|
||||
release = "latest"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@@ -70,10 +67,10 @@ language = None
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = "sphinx"
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
@@ -84,27 +81,27 @@ todo_include_todos = False
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
html_theme = "alabaster"
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
html_theme_options = {
|
||||
'description': "Jupyter Docker Stacks",
|
||||
'fixed_sidebar': False,
|
||||
'show_relbars': True,
|
||||
'github_user': 'jupyter',
|
||||
'github_repo': 'docker-stacks',
|
||||
'github_type': 'star',
|
||||
'logo': 'jupyter-logo.svg',
|
||||
'logo_text_align': 'left'
|
||||
"description": "Jupyter Docker Stacks",
|
||||
"fixed_sidebar": False,
|
||||
"show_relbars": True,
|
||||
"github_user": "jupyter",
|
||||
"github_repo": "docker-stacks",
|
||||
"github_type": "star",
|
||||
"logo": "jupyter-logo.svg",
|
||||
"logo_text_align": "left",
|
||||
}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
html_static_path = ["_static"]
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
@@ -115,18 +112,18 @@ html_static_path = ['_static']
|
||||
# 'searchbox.html']``.
|
||||
#
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'navigation.html',
|
||||
'relations.html',
|
||||
'searchbox.html',
|
||||
"**": [
|
||||
"about.html",
|
||||
"navigation.html",
|
||||
"relations.html",
|
||||
"searchbox.html",
|
||||
]
|
||||
}
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'docker-stacksdoc'
|
||||
htmlhelp_basename = "docker-stacksdoc"
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
@@ -135,15 +132,12 @@ latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
@@ -153,8 +147,13 @@ latex_elements = {
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'docker-stacks.tex', 'docker-stacks Documentation',
|
||||
'Project Jupyter', 'manual'),
|
||||
(
|
||||
master_doc,
|
||||
"docker-stacks.tex",
|
||||
"docker-stacks Documentation",
|
||||
"Project Jupyter",
|
||||
"manual",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
@@ -162,10 +161,7 @@ latex_documents = [
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'docker-stacks', 'docker-stacks Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
man_pages = [(master_doc, "docker-stacks", "docker-stacks Documentation", [author], 1)]
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
@@ -174,9 +170,15 @@ man_pages = [
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'docker-stacks', 'docker-stacks Documentation',
|
||||
author, 'docker-stacks', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
(
|
||||
master_doc,
|
||||
"docker-stacks",
|
||||
"docker-stacks Documentation",
|
||||
author,
|
||||
"docker-stacks",
|
||||
"One line description of project.",
|
||||
"Miscellaneous",
|
||||
),
|
||||
]
|
||||
|
||||
# -- Extension configuration ----------------------------------------------
|
||||
@@ -187,4 +189,4 @@ linkcheck_anchors = False
|
||||
# -- Translation ----------------------------------------------------------
|
||||
|
||||
gettext_uuid = True
|
||||
locale_dirs = ['locale/']
|
||||
locale_dirs = ["locale/"]
|
||||
|
Reference in New Issue
Block a user