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 import ast
  16 from pathlib import Path
  17 import re
  18 import shutil
  19 import string
  20
  21 from recommonmark.parser import CommonMarkParser
  22
  23
  24 CURRENT_DIR = Path(__file__).parent
  25
  26
  27 def get_version():
  28     black_py = CURRENT_DIR / ".." / "black.py"
  29     _version_re = re.compile(r"__version__\s+=\s+(?P<version>.*)")
  30     with open(str(black_py), "r", encoding="utf8") as f:
  31         version = _version_re.search(f.read()).group("version")
  32     return str(ast.literal_eval(version))
  33
  34
  35 def make_pypi_svg(version):
  36     template = CURRENT_DIR / "_static" / "pypi_template.svg"
  37     target = CURRENT_DIR / "_static" / "pypi.svg"
  38     with open(str(template), "r", encoding="utf8") as f:
  39         svg = string.Template(f.read()).substitute(version=version)
  40     with open(str(target), "w", encoding="utf8") as f:
  41         f.write(svg)
  42
  43
  44 def make_filename(line):
  45     non_letters = re.compile(r"[^a-z]+")
  46     filename = line[3:].rstrip().lower()
  47     filename = non_letters.sub("_", filename)
  48     if filename.startswith("_"):
  49         filename = filename[1:]
  50     if filename.endswith("_"):
  51         filename = filename[:-1]
  52     return filename + ".md"
  53
  54
  55 def generate_sections_from_readme():
  56     target_dir = CURRENT_DIR / "_build" / "generated"
  57     readme = CURRENT_DIR / ".." / "README.md"
  58     shutil.rmtree(str(target_dir), ignore_errors=True)
  59     target_dir.mkdir(parents=True)
  60
  61     output = None
  62     target_dir = target_dir.relative_to(CURRENT_DIR)
  63     with open(str(readme), "r", encoding="utf8") as f:
  64         for line in f:
  65             if line.startswith("## "):
  66                 if output is not None:
  67                     output.close()
  68                 filename = make_filename(line)
  69                 output_path = CURRENT_DIR / filename
  70                 if output_path.is_symlink() or output_path.is_file():
  71                     output_path.unlink()
  72                 output_path.symlink_to(target_dir / filename)
  73                 output = open(str(output_path), "w", encoding="utf8")
  74                 output.write(
  75                     "[//]: # (NOTE: THIS FILE IS AUTOGENERATED FROM README.md)\n\n"
  76                 )
  77
  78             if output is None:
  79                 continue
  80
  81             if line.startswith("##"):
  82                 line = line[1:]
  83
  84             output.write(line)
  85
  86
  87 # -- Project information -----------------------------------------------------
  88
  89 project = "Black"
  90 copyright = "2018, Łukasz Langa and contributors to Black"
  91 author = "Łukasz Langa and contributors to Black"
  92
  93 # Autopopulate version
  94 # The full version, including alpha/beta/rc tags.
  95 release = get_version()
  96 # The short X.Y version.
  97 version = release
  98 for sp in "abcfr":
  99     version = version.split(sp)[0]
 100 make_pypi_svg(release)
 101 generate_sections_from_readme()
 102
 103
 104 # -- General configuration ---------------------------------------------------
 105
 106 # If your documentation needs a minimal Sphinx version, state it here.
 107 #
 108 # needs_sphinx = '1.0'
 109
 110 # Add any Sphinx extension module names here, as strings. They can be
 111 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 112 # ones.
 113 extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.napoleon"]
 114
 115 # Add any paths that contain templates here, relative to this directory.
 116 templates_path = ["_templates"]
 117
 118 source_parsers = {".md": CommonMarkParser}
 119
 120 # The suffix(es) of source filenames.
 121 # You can specify multiple suffix as a list of string:
 122 source_suffix = [".rst", ".md"]
 123
 124 # The master toctree document.
 125 master_doc = "index"
 126
 127 # The language for content autogenerated by Sphinx. Refer to documentation
 128 # for a list of supported languages.
 129 #
 130 # This is also used if you do content translation via gettext catalogs.
 131 # Usually you set "language" from the command line for these cases.
 132 language = None
 133
 134 # List of patterns, relative to source directory, that match files and
 135 # directories to ignore when looking for source files.
 136 # This pattern also affects html_static_path and html_extra_path .
 137 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 138
 139 # The name of the Pygments (syntax highlighting) style to use.
 140 pygments_style = "sphinx"
 141
 142
 143 # -- Options for HTML output -------------------------------------------------
 144
 145 # The theme to use for HTML and HTML Help pages.  See the documentation for
 146 # a list of builtin themes.
 147 #
 148 html_theme = "alabaster"
 149
 150 html_sidebars = {
 151     "**": [
 152         "about.html",
 153         "navigation.html",
 154         "relations.html",
 155         "sourcelink.html",
 156         "searchbox.html",
 157     ]
 158 }
 159
 160 html_theme_options = {
 161     "show_related": False,
 162     "description": "“Any color you like.”",
 163     "github_button": True,
 164     "github_user": "python",
 165     "github_repo": "black",
 166     "github_type": "star",
 167     "show_powered_by": True,
 168     "fixed_sidebar": True,
 169     "logo": "logo2.png",
 170     "travis_button": True,
 171 }
 172
 173
 174 # Add any paths that contain custom static files (such as style sheets) here,
 175 # relative to this directory. They are copied after the builtin static files,
 176 # so a file named "default.css" will overwrite the builtin "default.css".
 177 html_static_path = ["_static"]
 178
 179 # Custom sidebar templates, must be a dictionary that maps document names
 180 # to template names.
 181 #
 182 # The default sidebars (for documents that don't match any pattern) are
 183 # defined by theme itself.  Builtin themes are using these templates by
 184 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 185 # 'searchbox.html']``.
 186 #
 187 # html_sidebars = {}
 188
 189
 190 # -- Options for HTMLHelp output ---------------------------------------------
 191
 192 # Output file base name for HTML help builder.
 193 htmlhelp_basename = "blackdoc"
 194
 195
 196 # -- Options for LaTeX output ------------------------------------------------
 197
 198 latex_elements = {
 199     # The paper size ('letterpaper' or 'a4paper').
 200     #
 201     # 'papersize': 'letterpaper',
 202     # The font size ('10pt', '11pt' or '12pt').
 203     #
 204     # 'pointsize': '10pt',
 205     # Additional stuff for the LaTeX preamble.
 206     #
 207     # 'preamble': '',
 208     # Latex figure (float) alignment
 209     #
 210     # 'figure_align': 'htbp',
 211 }
 212
 213 # Grouping the document tree into LaTeX files. List of tuples
 214 # (source start file, target name, title,
 215 #  author, documentclass [howto, manual, or own class]).
 216 latex_documents = [
 217     (
 218         master_doc,
 219         "black.tex",
 220         "Documentation for Black",
 221         "Łukasz Langa and contributors to Black",
 222         "manual",
 223     )
 224 ]
 225
 226
 227 # -- Options for manual page output ------------------------------------------
 228
 229 # One entry per manual page. List of tuples
 230 # (source start file, name, description, authors, manual section).
 231 man_pages = [(master_doc, "black", "Documentation for Black", [author], 1)]
 232
 233
 234 # -- Options for Texinfo output ----------------------------------------------
 235
 236 # Grouping the document tree into Texinfo files. List of tuples
 237 # (source start file, target name, title, author,
 238 #  dir menu entry, description, category)
 239 texinfo_documents = [
 240     (
 241         master_doc,
 242         "Black",
 243         "Documentation for Black",
 244         author,
 245         "Black",
 246         "The uncompromising Python code formatter",
 247         "Miscellaneous",
 248     )
 249 ]
 250
 251
 252 # -- Options for Epub output -------------------------------------------------
 253
 254 # Bibliographic Dublin Core info.
 255 epub_title = project
 256 epub_author = author
 257 epub_publisher = author
 258 epub_copyright = copyright
 259
 260 # The unique identifier of the text. This can be a ISBN number
 261 # or the project homepage.
 262 #
 263 # epub_identifier = ''
 264
 265 # A unique identification for the text.
 266 #
 267 # epub_uid = ''
 268
 269 # A list of files that should not be packed into the epub file.
 270 epub_exclude_files = ["search.html"]
 271
 272
 273 # -- Extension configuration -------------------------------------------------
 274
 275 autodoc_member_order = "bysource"
 276
 277 # -- Options for intersphinx extension ---------------------------------------
 278
 279 # Example configuration for intersphinx: refer to the Python standard library.
 280 intersphinx_mapping = {"https://docs.python.org/3/": None}