Support comments in the redirects file (#29)

Author: phlax

README.md

@@ -7,7 +7,7 @@ Sphinx Extension to redirect files
 ![Rediraffe](assets/rediraffe_logo.svg)
 
 This sphinx extension redirects non-existent pages to working pages.
-Additionally, a builder is provided to check that deleted/renamed files in your git repo are redirected. 
+Additionally, a builder is provided to check that deleted/renamed files in your git repo are redirected.
 
 Rediraffe supports the html and dirhtml builders.
 
@@ -69,6 +69,7 @@ rediraffe_redirects = "redirects.txt"
 
 redirects.txt:
 ```
+# comments start with "#"
 "another file.rst" index.rst
 another2.rst 'another file.rst'
 ```

sphinxext/rediraffe.py

@@ -52,7 +52,7 @@ def create_graph(path: Path) -> Dict[str, str]:
     with open(path, "r") as file:
         for line_num, line in enumerate(file):
             line = line.strip()
-            if len(line) == 0:
+            if len(line) == 0 or line.startswith("#"):
                 continue
             match = RE_OBJ.fullmatch(line)
 

tests/test_create_graph.py

@@ -113,6 +113,24 @@ def test_both_single_quotes(self, tmp_path):
             "d": "e",
         }
 
+    def test_commented(self, tmp_path):
+        path = tmp_path / "rediraffe.txt"
+        path.write_text(
+            """
+            # a comment
+            a b
+            c d
+            # another comment
+            d e
+            """
+        )
+        graph = create_graph(path)
+        assert graph == {
+            "a": "b",
+            "c": "d",
+            "d": "e",
+        }
+
     def test_double_quotes(self, tmp_path):
         path = tmp_path / "rediraffe.txt"
         path.write_text(