docs/index.rst

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