black/docs/usage_and_configuration/index.md
Gunung P. Wibisono 3dea6e3635
Convert index.rst and license.rst to markdown (#2852)
Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
2022-03-30 13:43:46 -07:00

969 B

Usage and Configuration

---
hidden:
---

the_basics
file_collection_and_discovery
black_as_a_server
black_docker_image

Sometimes, running Black with its defaults and passing filepaths to it just won't cut it. Passing each file using paths will become burdensome, and maybe you would like Black to not touch your files and just output diffs. And yes, you can tweak certain parts of Black's style, but please know that configurability in this area is purposefully limited.

Using many of these more advanced features of Black will require some configuration. Configuration that will either live on the command line or in a TOML configuration file.

This section covers features of Black and configuring Black in detail:

  • {doc}The basics <./the_basics>
  • {doc}File collection and discovery <file_collection_and_discovery>
  • {doc}Black as a server (blackd) <./black_as_a_server>
  • {doc}Black Docker image <./black_docker_image>