X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c98a6f134f4b2b831e7e659de0c217c118270a61..8842c5ffa888aab2e4961fc54db45e7f3ca32ad9:/docs/index.rst diff --git a/docs/index.rst b/docs/index.rst index 0106c9c..676644e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,25 +1,24 @@ .. 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 `_. + .. note:: - Black is an early pre-release. + `Black is beta `_. Testimonials @@ -29,7 +28,7 @@ Testimonials *Black is opinionated so you don't have to be.* -**Hynek Schlawack**, creator of `attrs `_, core +**Hynek Schlawack**, creator of `attrs `_, core developer of Twisted and CPython: *An auto-formatter that doesn't suck is all I want for Xmas!* @@ -49,11 +48,19 @@ Contents .. toctree:: :maxdepth: 2 - usage - technical_philosophy - contributors_guide - changelog - + installation_and_usage + the_black_code_style + pyproject_toml + editor_integration + blackd + black_primer + version_control_integration + ignoring_unmodified_files + contributing_to_black + show_your_style + change_log + reference/reference_summary + authors Indices and tables ==================