File tree Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -11,6 +11,19 @@ Most of the tools presented can be configured using :ref:`the
11
11
cleaner root project directory.
12
12
13
13
14
+ Blacken-Docs
15
+ ------------
16
+
17
+ When writing documentation, it is frequent to include code-blocks which are used
18
+ as examples. However, these code snippets cannot be tested with the usual code
19
+ formatting tools. This is where `blacken-docs `_ comes into play. You can execute
20
+ this tool by running:
21
+
22
+ .. code :: bash
23
+
24
+ blacken-docs -l < line-length> doc/** /* .rst
25
+
26
+
14
27
Codespell
15
28
---------
16
29
@@ -124,6 +137,7 @@ under the ``[tool.pydocstyle]`` entry:
124
137
convention = "numpy"
125
138
126
139
140
+ .. _blacken-docs : https://github.com/asottile/blacken-docs
127
141
.. _interrogate : https://interrogate.readthedocs.io/en/latest/
128
142
.. _docstr-coverage : https://docstr-coverage.readthedocs.io/en/latest/index.html
129
143
.. _docstring-coverage : https://bitbucket.org/DataGreed/docstring-coverage/wiki/Home
You can’t perform that action at this time.
0 commit comments