.. black documentation master file, created by
sphinx-quickstart on Fri Mar 23 10:53:30 2018.
-Black
-=====
+The uncompromising code formatter
+=================================
-**Black** is the uncompromising Python code formatter.
-
-By using *Black*, you
-agree to cease control over minutiae of hand-formatting. In return,
-*Black* gives you speed, determinism, and freedom from `pycodestyle`
-nagging about formatting. You will save time and mental energy for
-more important matters.
+By using *Black*, you agree to cede control over minutiae of
+hand-formatting. In return, *Black* gives you speed, determinism, and
+freedom from `pycodestyle` nagging about formatting. You will save time
+and mental energy for more important matters.
*Black* makes code review faster by producing the smallest diffs
possible. Blackened code looks the same regardless of the project
you're reading. Formatting becomes transparent after a while and you
can focus on the content instead.
+Try it out now using the `Black Playground <https://black.now.sh>`_.
+
.. note::
- Black is an early pre-release.
+ `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
Testimonials
*Black is opinionated so you don't have to be.*
-**Hynek Schlawack**, creator of `attrs <http://www.attrs.org/>`_, core
+**Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core
developer of Twisted and CPython:
*An auto-formatter that doesn't suck is all I want for Xmas!*
.. toctree::
:maxdepth: 2
- usage
- technical_philosophy
- contributors_guide
- changelog
-
+ installation_and_usage
+ the_black_code_style
+ pyproject_toml
+ compatible_configs
+ editor_integration
+ blackd
+ black_primer
+ version_control_integration
+ github_actions
+ ignoring_unmodified_files
+ contributing_to_black
+ show_your_style
+ change_log
+ reference/reference_summary
+ authors
Indices and tables
==================
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
projects / etc / vim.git / blobdiff