diff options
Diffstat (limited to 'docs/dev/makefile.rst')
| -rw-r--r-- | docs/dev/makefile.rst | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 4781b2ce6..ea7ddecd8 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -188,24 +188,22 @@ sources of the theme need to be rebuild. You can do that by running:: $ LIVE_THEME=simple make run -.. _make format.python: +.. _make format: -``make format.python`` +``make format`` ====================== -Format Python source code using `Black code style`_. See ``$BLACK_OPTIONS`` -and ``$BLACK_TARGETS`` in :origin:`Makefile`. - -.. attention:: +.. _Black code style: + https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html +.. _shfmt: https://github.com/mvdan/sh?tab=readme-ov-file#shfmt +.. _EditorConfig: https://github.com/patrickvane/shfmt?tab=readme-ov-file#description - We stuck at Black 22.12.0, please read comment in PR `Bump black from 22.12.0 - to 23.1.0`_ +- Format Python source code using `Black code style`_. See ``$BLACK_OPTIONS`` + and ``$BLACK_TARGETS`` in :origin:`Makefile`. -.. _Bump black from 22.12.0 to 23.1.0: - https://github.com/searxng/searxng/pull/2159#pullrequestreview-1284094735 +- Format Shell scripts using shfmt_. The formatter ``shfmt`` reads the rules + from the EditorConfig_ files. -.. _Black code style: - https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html .. _make clean: |