Skip to content

Commit d430c01

Browse files
Docs: Try with colon fence
1 parent 0b65571 commit d430c01

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ import dir_content_diff
6666
dir_content_diff.compare_trees("reference_dir", "compared_dir")
6767
```
6868

69-
> [!WARNING]
70-
> The order of the parameters is important: the first path is considered as the `reference`
71-
> directory while the second one is the `compared` directory. Inverting the parameters may return
72-
> a different result (in this example it would return that the file `sub_file_3.b` is missing).
69+
::::{important}
70+
The order of the parameters is important: the first path is considered as the `reference`
71+
directory while the second one is the `compared` directory. Inverting the parameters may return
72+
a different result (in this example it would return that the file `sub_file_3.b` is missing).
73+
::::
7374

7475
If all the files are identical, this code will return an empty dictionary because no difference
7576
was detected. As mentioned previously, this is because `dir-content-diff` is only looking for files

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
}
102102

103103
# MyST parser settings
104-
myst_enable_extensions = []
104+
myst_enable_extensions = ["colon_fence"]
105105
myst_heading_anchors = 5
106106
myst_all_links_external = True
107107
suppress_warnings = ["myst.header"]

0 commit comments

Comments
 (0)