All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
1 # -*- coding: utf-8 -*-
3 # Configuration file for the Sphinx documentation builder.
5 # This file does only contain a selection of the most common options. For a
6 # full list see the documentation:
7 # http://www.sphinx-doc.org/en/stable/config
9 # -- Path setup --------------------------------------------------------------
11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
15 from pathlib import Path
18 from pkg_resources import get_distribution
20 CURRENT_DIR = Path(__file__).parent
23 def make_pypi_svg(version: str) -> None:
24 template: Path = CURRENT_DIR / "_static" / "pypi_template.svg"
25 target: Path = CURRENT_DIR / "_static" / "pypi.svg"
26 with open(str(template), "r", encoding="utf8") as f:
27 svg: str = string.Template(f.read()).substitute(version=version)
28 with open(str(target), "w", encoding="utf8") as f:
32 # -- Project information -----------------------------------------------------
35 copyright = "2018-Present, Łukasz Langa and contributors to Black"
36 author = "Łukasz Langa and contributors to Black"
38 # Autopopulate version
39 # The version, including alpha/beta/rc tags, but not commit hash and datestamps
40 release = get_distribution("black").version.split("+")[0]
41 # The short X.Y version.
44 version = version.split(sp)[0]
46 make_pypi_svg(release)
49 # -- General configuration ---------------------------------------------------
51 # If your documentation needs a minimal Sphinx version, state it here.
54 # Add any Sphinx extension module names here, as strings. They can be
55 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
59 "sphinx.ext.intersphinx",
60 "sphinx.ext.napoleon",
64 # If you need extensions of a certain version or higher, list them here.
65 needs_extensions = {"myst_parser": "0.13.7"}
67 # Add any paths that contain templates here, relative to this directory.
68 templates_path = ["_templates"]
70 # The suffix(es) of source filenames.
71 # You can specify multiple suffix as a list of string:
72 source_suffix = [".rst", ".md"]
74 # The master toctree document.
77 # The language for content autogenerated by Sphinx. Refer to documentation
78 # for a list of supported languages.
80 # This is also used if you do content translation via gettext catalogs.
81 # Usually you set "language" from the command line for these cases.
84 # List of patterns, relative to source directory, that match files and
85 # directories to ignore when looking for source files.
86 # This pattern also affects html_static_path and html_extra_path .
88 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
90 # The name of the Pygments (syntax highlighting) style to use.
91 pygments_style = "sphinx"
93 # We need headers to be linkable to so ask MyST-Parser to autogenerate anchor IDs for
94 # headers up to and including level 3.
95 myst_heading_anchors = 3
97 # Prettier support formatting some MyST syntax but not all, so let's disable the
98 # unsupported yet still enabled by default ones.
99 myst_disable_syntax = [
105 # -- Options for HTML output -------------------------------------------------
107 # The theme to use for HTML and HTML Help pages. See the documentation for
108 # a list of builtin themes.
110 html_theme = "alabaster"
121 html_theme_options = {
122 "show_related": False,
123 "description": "“Any color you like.”",
124 "github_button": True,
125 "github_user": "psf",
126 "github_repo": "black",
127 "github_type": "star",
128 "show_powered_by": True,
129 "fixed_sidebar": True,
134 # Add any paths that contain custom static files (such as style sheets) here,
135 # relative to this directory. They are copied after the builtin static files,
136 # so a file named "default.css" will overwrite the builtin "default.css".
137 html_static_path = ["_static"]
139 # Custom sidebar templates, must be a dictionary that maps document names
142 # The default sidebars (for documents that don't match any pattern) are
143 # defined by theme itself. Builtin themes are using these templates by
144 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
145 # 'searchbox.html']``.
150 # -- Options for HTMLHelp output ---------------------------------------------
152 # Output file base name for HTML help builder.
153 htmlhelp_basename = "blackdoc"
156 # -- Options for LaTeX output ------------------------------------------------
158 # Grouping the document tree into LaTeX files. List of tuples
159 # (source start file, target name, title,
160 # author, documentclass [howto, manual, or own class]).
165 "Documentation for Black",
166 "Łukasz Langa and contributors to Black",
172 # -- Options for manual page output ------------------------------------------
174 # One entry per manual page. List of tuples
175 # (source start file, name, description, authors, manual section).
176 man_pages = [(master_doc, "black", "Documentation for Black", [author], 1)]
179 # -- Options for Texinfo output ----------------------------------------------
181 # Grouping the document tree into Texinfo files. List of tuples
182 # (source start file, target name, title, author,
183 # dir menu entry, description, category)
184 texinfo_documents = [
188 "Documentation for Black",
191 "The uncompromising Python code formatter",
197 # -- Options for Epub output -------------------------------------------------
199 # Bibliographic Dublin Core info.
202 epub_publisher = author
203 epub_copyright = copyright
205 # The unique identifier of the text. This can be a ISBN number
206 # or the project homepage.
208 # epub_identifier = ''
210 # A unique identification for the text.
214 # A list of files that should not be packed into the epub file.
215 epub_exclude_files = ["search.html"]
218 # -- Extension configuration -------------------------------------------------
220 autodoc_member_order = "bysource"
222 # -- Options for intersphinx extension ---------------------------------------
224 # Example configuration for intersphinx: refer to the Python standard library.
225 intersphinx_mapping = {"https://docs.python.org/3/": None}