]> git.madduck.net Git - etc/vim.git/blob - docs/integrations/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:

bump sphinx so it works on Python3.10 (#2546)
[etc/vim.git] / docs / integrations / index.rst
1 Integrations
2 ============
3
4 .. toctree::
5     :hidden:
6
7     editors
8     github_actions
9     source_version_control
10
11 *Black* can be integrated into many environments, providing a better and smoother experience. Documentation for integrating *Black* with a tool can be found for the
12 following areas:
13
14 - :doc:`Editor / IDE <./editors>`
15 - :doc:`GitHub Actions <./github_actions>`
16 - :doc:`Source version control <./source_version_control>`
17
18 Editors and tools not listed will require external contributions.
19
20 Patches welcome! ✨ 🍰 ✨
21
22 Any tool can pipe code through *Black* using its stdio mode (just
23 `use \`-\` as the file name <https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2>`_).
24 The formatted code will be returned on stdout (unless ``--check`` was passed). *Black*
25 will still emit messages on stderr but that shouldn't affect your use case.
26
27 This can be used for example with PyCharm's or IntelliJ's
28 `File Watchers <https://www.jetbrains.com/help/pycharm/file-watchers.html>`_.