docs/index.rst

   1 .. black documentation master file, created by
   2    sphinx-quickstart on Fri Mar 23 10:53:30 2018.
   3
   4 The uncompromising code formatter
   5 =================================
   6
   7 By using *Black*, you agree to cease control over minutiae of
   8 hand-formatting. In return, *Black* gives you speed, determinism, and
   9 freedom from `pycodestyle` nagging about formatting. You will save time
  10 and mental energy for more important matters.
  11
  12 *Black* makes code review faster by producing the smallest diffs
  13 possible. Blackened code looks the same regardless of the project
  14 you're reading. Formatting becomes transparent after a while and you
  15 can focus on the content instead.
  16
  17 .. note::
  18
  19    `Black is an early pre-release <installation_and_usage.html#note-this-is-an-early-pre-release>`_.
  20
  21
  22 Testimonials
  23 ------------
  24
  25 **Dusty Phillips**, `writer <https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips>`_:
  26
  27    *Black is opinionated so you don't have to be.*
  28
  29 **Hynek Schlawack**, creator of `attrs <http://www.attrs.org/>`_, core
  30 developer of Twisted and CPython:
  31
  32    *An auto-formatter that doesn't suck is all I want for Xmas!*
  33
  34 **Carl Meyer**, `Django <https://www.djangoproject.com/>`_ core developer:
  35
  36    *At least the name is good.*
  37
  38 **Kenneth Reitz**, creator of `requests <http://python-requests.org/>`_
  39 and `pipenv <https://docs.pipenv.org/>`_:
  40
  41    *This vastly improves the formatting of our code. Thanks a ton!*
  42
  43 Contents
  44 --------
  45
  46 .. toctree::
  47    :maxdepth: 2
  48
  49    installation_and_usage
  50    the_black_code_style
  51    editor_integration
  52    version_control_integration
  53    ignoring_non_modified_files
  54    contributing
  55    change_log
  56    reference/reference_summary
  57    authors
  58
  59 Indices and tables
  60 ==================
  61
  62 * :ref:`genindex`
  63 * :ref:`modindex`
  64 * :ref:`search`