From 09e473a0dc49d265e818ccd7d5b19a43065dc6fc Mon Sep 17 00:00:00 2001
From: Andrej730 <azhilenkov@gmail.com>
Date: Fri, 15 Mar 2024 11:57:34 +0500
Subject: [PATCH] python code style docs

---
 src/blenderbim/docs/devs/code_style.rst | 20 ++++++++++++++++++++
 src/blenderbim/docs/index.rst           |  1 +
 2 files changed, 21 insertions(+)
 create mode 100644 src/blenderbim/docs/devs/code_style.rst

diff --git a/src/blenderbim/docs/devs/code_style.rst b/src/blenderbim/docs/devs/code_style.rst
new file mode 100644
index 0000000000..2ee2b5f204
--- /dev/null
+++ b/src/blenderbim/docs/devs/code_style.rst
@@ -0,0 +1,20 @@
+Code style
+============
+
+
+Black code formatter
+-------------------------------
+For Python code formatting, we use `Black code formatter <https://pypi.org/project/black/>`__ with ``--line-length 120``.
+
+``black`` can be installed using ``pip install black`` and files can be formatted with the following example command:
+
+.. code-block:: bash
+
+   black --line-length 120 src/blenderbim/blenderbim/bim/module/qto/operator.py
+
+Using PowerShell, you can run the Black formatter on the last commit in the repository.
+You can change ``~1`` to ``~n`` to affect ``n`` commits.
+
+.. code-block:: powershell
+
+   git diff HEAD HEAD~1 --name-only | where {$_ -like "*.py"} | foreach-object { start $_ && black --line-length 120 $_ }
diff --git a/src/blenderbim/docs/index.rst b/src/blenderbim/docs/index.rst
index 662b914e17..b8f21e5a6b 100644
--- a/src/blenderbim/docs/index.rst
+++ b/src/blenderbim/docs/index.rst
@@ -40,6 +40,7 @@ Learn how to model a small building and create simple architectural plans, secti
 
    devs/installation
    devs/hello_world
+   devs/code_style
    devs/running_tests
    devs/writing_docs
    devs/translations