Added docs for new option.

adamchainz · Dec 2, 2022 · cc6ed57 · cc6ed57
1 parent a121cc0
commit cc6ed57
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ options:
 Following additional parameters can be used:
 
  - `-E` / `--skip-errors`
+ - `--use-sphinx-default`
 
 `blacken-docs` will format code in the following block types:
 
@@ -60,6 +61,16 @@ Following additional parameters can be used:
             print("hello world")
 ```
 
+(rst using Sphinx default for blocks marked with `::`)
+``rst
+    hello::
+
+        def hello():
+            print("hello world")
+```
+
+This style is enabled with the `--use-sphinx-default` option.
+
 (rst `pycon`)
 ```rst
     .. code-block:: pycon