]> git.madduck.net Git - etc/vim.git/blobdiff - docs/index.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Allow setting custom cache directory on all platforms (#2739)
[etc/vim.git] / docs / index.rst
index da60f7b2725e9f08fdfac1cfc4769f19e25e1037..6818c03cfe9b0c7ff213c1521c4c178db12b725f 100644 (file)
@@ -4,6 +4,8 @@
 The uncompromising code formatter
 =================================
 
+    “Any color you like.”
+
 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
@@ -14,19 +16,43 @@ 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.
 
-.. note::
+Try it out now using the `Black Playground <https://black.vercel.app>`_.
 
-   `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
+.. admonition:: Note - this is a beta product
 
+   *Black* is already `successfully used <https://github.com/psf/black#used-by>`_ by
+   many projects, small and big. *Black* has a comprehensive test suite, with efficient
+   parallel tests, our own auto  formatting and parallel Continuous Integration runner.
+   However, *Black* is still beta. Things will probably be wonky for a while. This is
+   made explicit by the "Beta" trove classifier, as well as by the "b" in the version
+   number. What this means for you is that **until the formatter becomes stable, you
+   should expect some formatting to change in the future**. That being said, no drastic
+   stylistic changes are planned, mostly responses to bug reports.
+
+   Also, as a safety measure which slows down processing, *Black* will check that the
+   reformatted code still produces a valid AST that is effectively equivalent to the
+   original (see the
+   `Pragmatism <./the_black_code_style/current_style.html#pragmatism>`_
+   section for details). If you're feeling confident, use ``--fast``.
+
+.. note::
+   :doc:`Black is licensed under the MIT license <license>`.
 
 Testimonials
 ------------
 
+**Mike Bayer**, author of `SQLAlchemy <https://www.sqlalchemy.org/>`_:
+
+   *I can't think of any single tool in my entire programming career that has given me a
+   bigger productivity increase by its introduction. I can now do refactorings in about
+   1% of the keystrokes that it would have taken me previously when we had no way for
+   code to format itself.*
+
 **Dusty Phillips**, `writer <https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips>`_:
 
    *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!*
@@ -40,27 +66,68 @@ and `pipenv <https://docs.pipenv.org/>`_:
 
    *This vastly improves the formatting of our code. Thanks a ton!*
 
+
+Show your style
+---------------
+
+Use the badge in your project's README.md:
+
+.. code-block:: md
+
+   [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
+Using the badge in README.rst:
+
+.. code-block:: rst
+
+   .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+      :target: https://github.com/psf/black
+
+Looks like this:
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
 Contents
 --------
 
+.. toctree::
+   :maxdepth: 3
+   :includehidden:
+
+   the_black_code_style/index
+
+.. toctree::
+   :maxdepth: 3
+   :includehidden:
+   :caption: User Guide
+
+   getting_started
+   usage_and_configuration/index
+   integrations/index
+   guides/index
+   faq
+
 .. toctree::
    :maxdepth: 2
+   :includehidden:
+   :caption: Development
 
-   installation_and_usage
-   the_black_code_style
-   pyproject_toml
-   editor_integration
-   version_control_integration
-   ignoring_unmodified_files
-   contributing
-   show_your_style
+   contributing/index
    change_log
-   reference/reference_summary
    authors
 
+.. toctree::
+   :hidden:
+   :caption: Project Links
+
+   GitHub <https://github.com/psf/black>
+   PyPI <https://pypi.org/project/black>
+   Chat <https://discord.gg/RtVdv86PrH>
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`