fix: badges in readme

sphinx_ape/_base.py

@@ -111,7 +111,16 @@ def quickstart_title(self) -> Optional[str]:
             readme = self.base_path / "README.md"
             if readme.is_file():
                 readme_text = readme.read_text()
-                first_line = readme_text.splitlines()[0].strip().lower()
+                found = False
+                for line in readme_text.splitlines():
+                    if line.strip().startswith("# "):
+                        first_line = line
+                        found = True
+                        break
+
+                if not found:
+                    return None
+
             else:
                 return None
 

tests/test_build.py

@@ -73,13 +73,15 @@ def test_userguide_names(self, temp_path, quickstart_name, quickstart_title):
 
         overview.unlink()
 
-
     @pytest.mark.parametrize("title", ("Overview", "Quickstart"))
-    def test_quickstart_name_when_readme(self, temp_path, title):
+    def test_quickstart_title_when_readme(self, temp_path, title):
         builder = DocumentationBuilder(mode=BuildMode.LATEST, base_path=temp_path)
         builder.init()
         readme = builder.base_path / "README.md"
-        readme.write_text(f"# {title}\n\nthis is a readme")
+
+        # Ensure to include random stuff before the title to show it still works.
+        readme.write_text(f"[![Pypi.org][pypi-badge]][pypi-url]\n\n# {title}\n\nthis is a readme")
+
         quickstart = builder.userguides_path / "quickstart.md"
         quickstart.write_text("```{include} ../../README.md\n```")
         actual = builder.quickstart_title