tweak doc-build so test is more robust

Author: almarklein

dash_slicer/docs.py

@@ -6,6 +6,9 @@
 import dash_slicer
 
 
+md_seperator = "<!--- The below is autogenerated - do not edit --->"  # noqa
+
+
 def dedent(text):
     """Dedent a docstring, removing leading whitespace."""
     lines = text.lstrip().splitlines()

tests/test_docs.py

@@ -1,6 +1,6 @@
 import os
 
-from dash_slicer.docs import get_reference_docs
+from dash_slicer.docs import get_reference_docs, md_seperator
 
 
 HERE = os.path.dirname(os.path.abspath(__file__))
@@ -18,7 +18,7 @@ def test_that_reference_docs_in_readme_are_up_to_date():
     assert os.path.isfile(filename)
     with open(filename, "rb") as f:
         text = f.read().decode()
-    _, _, ref = text.partition("## Reference")
+    _, _, ref = text.partition(md_seperator)
     ref1 = ref.strip().replace("\r\n", "\n")
     ref2 = get_reference_docs().strip()
     assert (

update_docs_in_readme.py

@@ -4,7 +4,7 @@
 """
 
 import os
-from dash_slicer.docs import get_reference_docs
+from dash_slicer.docs import get_reference_docs, md_seperator
 
 
 HERE = os.path.dirname(os.path.abspath(__file__))
@@ -13,17 +13,15 @@
 def write_reference_docs():
     """Write the reference docs to the README."""
     # Prepare
-    header = "## Reference"
-    note = "<!--- The below is autogenerated - do not edit --->"
     filename = os.path.join(HERE, "README.md")
     assert os.path.isfile(filename), "README.md not found"
     # Load first part of the readme
     with open(filename, "rb") as f:
         text = f.read().decode()
-    text1, _, _ = text.partition(header)
+    text1, _, _ = text.partition(md_seperator)
     text1 = text1.strip()
     # Create second part of the readme
-    text2 = "\n\n\n" + header + "\n\n" + note + "\n\n" + get_reference_docs()
+    text2 = "\n\n" + md_seperator + "\n\n" + get_reference_docs()
     if "\r" in text1:
         text2 = text2.replace("\n", "\r\n")
     # Wite