Skip to content

Commit

Permalink
Run black on docs config with manual spacing fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
CoolCat467 committed Jun 13, 2024
1 parent 903dfc3 commit d64908b
Showing 1 changed file with 36 additions and 31 deletions.
67 changes: 36 additions & 31 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@

# -- Project information -----------------------------------------------------

project = 'Trio WebSocket'
copyright = '2018, Hyperion Gray'
author = 'Hyperion Gray'
project = "Trio WebSocket"
copyright = "2018, Hyperion Gray"
author = "Hyperion Gray"

from trio_websocket._version import __version__ as version

release = version


Expand All @@ -37,22 +38,22 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinxcontrib_trio',
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinxcontrib_trio",
]

# 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.
Expand All @@ -64,7 +65,7 @@
# 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 = ['_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
Expand All @@ -75,7 +76,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"

# 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
Expand All @@ -86,7 +87,7 @@
# 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.
Expand All @@ -102,46 +103,44 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'TrioWebSocketdoc'
htmlhelp_basename = "TrioWebSocketdoc"


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# Additional stuff for the LaTeX preamble.
# 'preamble': '',

# Latex figure (float) alignment
#
# Latex figure (float) alignment
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'TrioWebSocket.tex', 'Trio WebSocket Documentation',
'Hyperion Gray', 'manual'),
(
master_doc,
"TrioWebSocket.tex",
"Trio WebSocket Documentation",
"Hyperion Gray",
"manual",
),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'triowebsocket', 'Trio WebSocket Documentation',
[author], 1)
]
man_pages = [(master_doc, "triowebsocket", "Trio WebSocket Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------
Expand All @@ -150,9 +149,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'TrioWebSocket', 'Trio WebSocket Documentation',
author, 'TrioWebSocket', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"TrioWebSocket",
"Trio WebSocket Documentation",
author,
"TrioWebSocket",
"One line description of project.",
"Miscellaneous",
),
]


Expand All @@ -171,10 +176,10 @@
# 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 -------------------------------------------------
intersphinx_mapping = {
'trio': ('https://trio.readthedocs.io/en/stable/', None),
"trio": ("https://trio.readthedocs.io/en/stable/", None),
}

0 comments on commit d64908b

Please sign in to comment.