Skip to content

Commit fddfd4a

Browse files
committed
add comment line in README example
1 parent 5d687a0 commit fddfd4a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sphinx Extension to redirect files
77
![Rediraffe](assets/rediraffe_logo.svg)
88

99
This sphinx extension redirects non-existent pages to working pages.
10-
Additionally, a builder is provided to check that deleted/renamed files in your git repo are redirected.
10+
Additionally, a builder is provided to check that deleted/renamed files in your git repo are redirected.
1111

1212
Rediraffe supports the html and dirhtml builders.
1313

@@ -69,6 +69,7 @@ rediraffe_redirects = "redirects.txt"
6969

7070
redirects.txt:
7171
```
72+
# comments start with "#"
7273
"another file.rst" index.rst
7374
another2.rst 'another file.rst'
7475
```

0 commit comments

Comments
 (0)