Global reformatting with black.

This commit is contained in:
Goffi 2025-09-13 10:46:10 +02:00
commit 96bf3af324
68 changed files with 557 additions and 561 deletions

View file

@ -4,16 +4,13 @@
def process_docstring(app, what, name, obj, options, lines):
lines[:] = [
l.replace("@param", ":param").replace("@raise", ":raises")
for l in lines
]
lines[:] = [l.replace("@param", ":param").replace("@raise", ":raises") for l in lines]
def setup(app):
app.connect("autodoc-process-docstring", process_docstring)
return {
'version': '0.1',
'parallel_read_safe': True,
'parallel_write_safe': True,
"version": "0.1",
"parallel_read_safe": True,
"parallel_write_safe": True,
}

View file

@ -1,4 +1,3 @@
#
# Configuration file for the Sphinx documentation builder.
#
@ -24,9 +23,9 @@ sys.path.insert(0, os.path.abspath("./_ext"))
# -- Project information -----------------------------------------------------
project = 'Libervia Backend'
copyright = '2019-2023 Libervia'
author = 'Libervia team'
project = "Libervia Backend"
copyright = "2019-2023 Libervia"
author = "Libervia team"
version = __version__
@ -60,22 +59,19 @@ rst_prolog = """
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"docstring"
]
extensions = ["sphinx.ext.autodoc", "docstring"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
templates_path = [".templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -87,7 +83,7 @@ language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [u'.build', 'Thumbs.db', '.DS_Store']
exclude_patterns = [".build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
@ -98,7 +94,7 @@ pygments_style = None
# 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
@ -109,7 +105,7 @@ html_theme = 'alabaster'
# 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.
@ -125,7 +121,7 @@ html_static_path = ['.static']
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'SalutToidoc'
htmlhelp_basename = "SalutToidoc"
# -- Options for LaTeX output ------------------------------------------------
@ -134,15 +130,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',
@ -152,8 +145,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'SalutToi.tex', u'Libervia Documentation',
u'Libervia team', 'manual'),
(master_doc, "SalutToi.tex", "Libervia Documentation", "Libervia team", "manual"),
]
@ -161,10 +153,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'saluttoi', u'Libervia Documentation',
[author], 1)
]
man_pages = [(master_doc, "saluttoi", "Libervia Documentation", [author], 1)]
# -- Options for Texinfo output ----------------------------------------------
@ -173,9 +162,15 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'SalutToi', u'Libervia Documentation',
author, 'SalutToi', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"SalutToi",
"Libervia Documentation",
author,
"SalutToi",
"One line description of project.",
"Miscellaneous",
),
]
@ -194,7 +189,7 @@ epub_title = project
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
epub_exclude_files = ["search.html"]
# -- Extension configuration -------------------------------------------------