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 os
  16 import sys
  17
  18 from recommonmark.parser import CommonMarkParser
  19
  20
  21 sys.path.insert(0, os.path.abspath('.' ))
  22
  23 # -- Project information -----------------------------------------------------
  24
  25 project = 'Black'
  26 copyright = '2018, Łukasz Langa and contributors to Black'
  27 author = 'Łukasz Langa and contributors to Black'
  28
  29 # Autopopulate version
  30 import black
  31 # The short X.Y version.
  32 # TODO: fix for 2 digit month
  33 version = f'{black.__version__[:4]}'
  34 # The full version, including alpha/beta/rc tags.
  35 release = black.__version__
  36
  37 # -- General configuration ---------------------------------------------------
  38
  39 # If your documentation needs a minimal Sphinx version, state it here.
  40 #
  41 # needs_sphinx = '1.0'
  42
  43 # Add any Sphinx extension module names here, as strings. They can be
  44 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  45 # ones.
  46 extensions = [
  47     'sphinx.ext.autodoc',
  48     'sphinx.ext.intersphinx',
  49 ]
  50
  51 # Add any paths that contain templates here, relative to this directory.
  52 templates_path = ['_templates']
  53
  54 source_parsers = {
  55     '.md': CommonMarkParser,
  56 }
  57
  58 # The suffix(es) of source filenames.
  59 # You can specify multiple suffix as a list of string:
  60 source_suffix = ['.rst', '.md']
  61
  62 # The master toctree document.
  63 master_doc = 'index'
  64
  65 # The language for content autogenerated by Sphinx. Refer to documentation
  66 # for a list of supported languages.
  67 #
  68 # This is also used if you do content translation via gettext catalogs.
  69 # Usually you set "language" from the command line for these cases.
  70 language = None
  71
  72 # List of patterns, relative to source directory, that match files and
  73 # directories to ignore when looking for source files.
  74 # This pattern also affects html_static_path and html_extra_path .
  75 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  76
  77 # The name of the Pygments (syntax highlighting) style to use.
  78 pygments_style = 'sphinx'
  79
  80
  81 # -- Options for HTML output -------------------------------------------------
  82
  83 # The theme to use for HTML and HTML Help pages.  See the documentation for
  84 # a list of builtin themes.
  85 #
  86 html_theme = 'alabaster'
  87
  88 html_sidebars = {
  89     '**': [
  90         'about.html',
  91         'navigation.html',
  92         'relations.html',
  93         'sourcelink.html',
  94         'searchbox.html'
  95     ]
  96 }
  97
  98 html_theme_options = {
  99     'show_related': True,
 100     'description': '“Any color you like.”',
 101     'github_button': True,
 102     'github_user': 'ambv',
 103     'github_repo': 'black',
 104     'github_type': 'star',
 105     'show_powered_by': True,
 106     'fixed_sidebar': True,
 107     'logo': 'logo2.png',
 108 }
 109
 110
 111 # Add any paths that contain custom static files (such as style sheets) here,
 112 # relative to this directory. They are copied after the builtin static files,
 113 # so a file named "default.css" will overwrite the builtin "default.css".
 114 html_static_path = ['_static']
 115
 116 # Custom sidebar templates, must be a dictionary that maps document names
 117 # to template names.
 118 #
 119 # The default sidebars (for documents that don't match any pattern) are
 120 # defined by theme itself.  Builtin themes are using these templates by
 121 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 122 # 'searchbox.html']``.
 123 #
 124 # html_sidebars = {}
 125
 126
 127 # -- Options for HTMLHelp output ---------------------------------------------
 128
 129 # Output file base name for HTML help builder.
 130 htmlhelp_basename = 'blackdoc'
 131
 132
 133 # -- Options for LaTeX output ------------------------------------------------
 134
 135 latex_elements = {
 136     # The paper size ('letterpaper' or 'a4paper').
 137     #
 138     # 'papersize': 'letterpaper',
 139
 140     # The font size ('10pt', '11pt' or '12pt').
 141     #
 142     # 'pointsize': '10pt',
 143
 144     # Additional stuff for the LaTeX preamble.
 145     #
 146     # 'preamble': '',
 147
 148     # Latex figure (float) alignment
 149     #
 150     # 'figure_align': 'htbp',
 151 }
 152
 153 # Grouping the document tree into LaTeX files. List of tuples
 154 # (source start file, target name, title,
 155 #  author, documentclass [howto, manual, or own class]).
 156 latex_documents = [
 157     (master_doc, 'black.tex', 'Documentation for Black',
 158      'Łukasz Langa and contributors to Black', 'manual'),
 159 ]
 160
 161
 162 # -- Options for manual page output ------------------------------------------
 163
 164 # One entry per manual page. List of tuples
 165 # (source start file, name, description, authors, manual section).
 166 man_pages = [
 167     (master_doc, 'black', 'Documentation for Black',
 168      [author], 1)
 169 ]
 170
 171
 172 # -- Options for Texinfo output ----------------------------------------------
 173
 174 # Grouping the document tree into Texinfo files. List of tuples
 175 # (source start file, target name, title, author,
 176 #  dir menu entry, description, category)
 177 texinfo_documents = [
 178     (master_doc, 'Black', 'Documentation for Black',
 179      author, 'Black', 'The uncompromising Python code formatter',
 180      'Miscellaneous'),
 181 ]
 182
 183
 184 # -- Options for Epub output -------------------------------------------------
 185
 186 # Bibliographic Dublin Core info.
 187 epub_title = project
 188 epub_author = author
 189 epub_publisher = author
 190 epub_copyright = copyright
 191
 192 # The unique identifier of the text. This can be a ISBN number
 193 # or the project homepage.
 194 #
 195 # epub_identifier = ''
 196
 197 # A unique identification for the text.
 198 #
 199 # epub_uid = ''
 200
 201 # A list of files that should not be packed into the epub file.
 202 epub_exclude_files = ['search.html']
 203
 204
 205 # -- Extension configuration -------------------------------------------------
 206
 207 # -- Options for intersphinx extension ---------------------------------------
 208
 209 # Example configuration for intersphinx: refer to the Python standard library.
 210 intersphinx_mapping = {'https://docs.python.org/3/': None}