docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Configuration file for the Sphinx documentation builder.
   4 #
   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
   8
   9 # -- Path setup --------------------------------------------------------------
  10
  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.
  14 #
  15 from pathlib import Path
  16 import string
  17
  18 from pkg_resources import get_distribution
  19
  20 CURRENT_DIR = Path(__file__).parent
  21
  22
  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:
  29         f.write(svg)
  30
  31
  32 # -- Project information -----------------------------------------------------
  33
  34 project = "Black"
  35 copyright = "2018-Present, Łukasz Langa and contributors to Black"
  36 author = "Łukasz Langa and contributors to Black"
  37
  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.
  42 version = release
  43 for sp in "abcfr":
  44     version = version.split(sp)[0]
  45
  46 make_pypi_svg(release)
  47
  48
  49 # -- General configuration ---------------------------------------------------
  50
  51 # If your documentation needs a minimal Sphinx version, state it here.
  52 needs_sphinx = "3.0"
  53
  54 # Add any Sphinx extension module names here, as strings. They can be
  55 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  56 # ones.
  57 extensions = [
  58     "sphinx.ext.autodoc",
  59     "sphinx.ext.intersphinx",
  60     "sphinx.ext.napoleon",
  61     "myst_parser",
  62     "sphinxcontrib.programoutput",
  63 ]
  64
  65 # If you need extensions of a certain version or higher, list them here.
  66 needs_extensions = {"myst_parser": "0.13.7"}
  67
  68 # Add any paths that contain templates here, relative to this directory.
  69 templates_path = ["_templates"]
  70
  71 # The suffix(es) of source filenames.
  72 # You can specify multiple suffix as a list of string:
  73 source_suffix = [".rst", ".md"]
  74
  75 # The master toctree document.
  76 master_doc = "index"
  77
  78 # The language for content autogenerated by Sphinx. Refer to documentation
  79 # for a list of supported languages.
  80 #
  81 # This is also used if you do content translation via gettext catalogs.
  82 # Usually you set "language" from the command line for these cases.
  83 language = None
  84
  85 # List of patterns, relative to source directory, that match files and
  86 # directories to ignore when looking for source files.
  87 # This pattern also affects html_static_path and html_extra_path .
  88
  89 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
  90
  91 # The name of the Pygments (syntax highlighting) style to use.
  92 pygments_style = "sphinx"
  93
  94 # We need headers to be linkable to so ask MyST-Parser to autogenerate anchor IDs for
  95 # headers up to and including level 3.
  96 myst_heading_anchors = 3
  97
  98 # Prettier support formatting some MyST syntax but not all, so let's disable the
  99 # unsupported yet still enabled by default ones.
 100 myst_disable_syntax = [
 101     "myst_block_break",
 102     "myst_line_comment",
 103     "math_block",
 104 ]
 105
 106 # -- Options for HTML output -------------------------------------------------
 107
 108 # The theme to use for HTML and HTML Help pages.  See the documentation for
 109 # a list of builtin themes.
 110 #
 111 html_theme = "alabaster"
 112
 113 html_sidebars = {
 114     "**": [
 115         "about.html",
 116         "navigation.html",
 117         "relations.html",
 118         "searchbox.html",
 119     ]
 120 }
 121
 122 html_theme_options = {
 123     "show_related": False,
 124     "description": "“Any color you like.”",
 125     "github_button": True,
 126     "github_user": "psf",
 127     "github_repo": "black",
 128     "github_type": "star",
 129     "show_powered_by": True,
 130     "fixed_sidebar": True,
 131     "logo": "logo2.png",
 132 }
 133
 134
 135 # Add any paths that contain custom static files (such as style sheets) here,
 136 # relative to this directory. They are copied after the builtin static files,
 137 # so a file named "default.css" will overwrite the builtin "default.css".
 138 html_static_path = ["_static"]
 139
 140 # Custom sidebar templates, must be a dictionary that maps document names
 141 # to template names.
 142 #
 143 # The default sidebars (for documents that don't match any pattern) are
 144 # defined by theme itself.  Builtin themes are using these templates by
 145 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 146 # 'searchbox.html']``.
 147 #
 148 # html_sidebars = {}
 149
 150
 151 # -- Options for HTMLHelp output ---------------------------------------------
 152
 153 # Output file base name for HTML help builder.
 154 htmlhelp_basename = "blackdoc"
 155
 156
 157 # -- Options for LaTeX output ------------------------------------------------
 158
 159 # Grouping the document tree into LaTeX files. List of tuples
 160 # (source start file, target name, title,
 161 #  author, documentclass [howto, manual, or own class]).
 162 latex_documents = [
 163     (
 164         master_doc,
 165         "black.tex",
 166         "Documentation for Black",
 167         "Łukasz Langa and contributors to Black",
 168         "manual",
 169     )
 170 ]
 171
 172
 173 # -- Options for manual page output ------------------------------------------
 174
 175 # One entry per manual page. List of tuples
 176 # (source start file, name, description, authors, manual section).
 177 man_pages = [(master_doc, "black", "Documentation for Black", [author], 1)]
 178
 179
 180 # -- Options for Texinfo output ----------------------------------------------
 181
 182 # Grouping the document tree into Texinfo files. List of tuples
 183 # (source start file, target name, title, author,
 184 #  dir menu entry, description, category)
 185 texinfo_documents = [
 186     (
 187         master_doc,
 188         "Black",
 189         "Documentation for Black",
 190         author,
 191         "Black",
 192         "The uncompromising Python code formatter",
 193         "Miscellaneous",
 194     )
 195 ]
 196
 197
 198 # -- Options for Epub output -------------------------------------------------
 199
 200 # Bibliographic Dublin Core info.
 201 epub_title = project
 202 epub_author = author
 203 epub_publisher = author
 204 epub_copyright = copyright
 205
 206 # The unique identifier of the text. This can be a ISBN number
 207 # or the project homepage.
 208 #
 209 # epub_identifier = ''
 210
 211 # A unique identification for the text.
 212 #
 213 # epub_uid = ''
 214
 215 # A list of files that should not be packed into the epub file.
 216 epub_exclude_files = ["search.html"]
 217
 218
 219 # -- Extension configuration -------------------------------------------------
 220
 221 autodoc_member_order = "bysource"
 222
 223 # -- Options for intersphinx extension ---------------------------------------
 224
 225 # Example configuration for intersphinx: refer to the Python standard library.
 226 intersphinx_mapping = {"https://docs.python.org/3/": None}