Merge pull request #215 from adamtheturtle/title-table

Error cleanly when a table is given a title

Author: adamtheturtle

src/sphinx_notion/__init__.py

@@ -458,18 +458,31 @@ def _(
         """
         del section_level
 
+        for child in node.children:
+            if isinstance(child, nodes.title):
+                table_no_titles_msg = (
+                    f"Table has a title '{child.astext()}', but Notion tables "
+                    "do not have titles."
+                )
+                # Ignore error which is about a type error, but we want to
+                # raise a value error because the user has not sent anything to
+                # do with types.
+                raise ValueError(table_no_titles_msg)  # noqa: TRY004
+
         table_structure = _extract_table_structure(node=node)
 
         if len(table_structure.header_rows) > 1:
-            msg = "Tables with multiple header rows are not supported."
-            raise ValueError(msg)
+            table_multiple_header_rows_msg = (
+                "Tables with multiple header rows are not supported."
+            )
+            raise ValueError(table_multiple_header_rows_msg)
 
         if table_structure.num_stub_columns > 1:
-            msg = (
+            table_more_than_one_stub_column_msg = (
                 f"Tables with more than 1 stub column are not supported. "
                 f"Found {table_structure.num_stub_columns} stub columns."
             )
-            raise ValueError(msg)
+            raise ValueError(table_more_than_one_stub_column_msg)
 
         rows = [*table_structure.header_rows, *table_structure.body_rows]
         table = UnoTable(

tests/test_integration.py

@@ -1919,3 +1919,35 @@ def test_list_table_stub_columns_two(
             make_app=make_app,
             tmp_path=tmp_path,
         )
+
+
+def test_list_table_with_title_error(
+    *,
+    make_app: Callable[..., SphinxTestApp],
+    tmp_path: Path,
+) -> None:
+    """
+    List table with title raises ValueError since Notion tables do not have
+    titles.
+    """
+    rst_content = """
+        .. list-table:: My Table Title
+           :header-rows: 1
+
+           * - Header 1
+             - Header 2
+           * - Cell 1
+             - Cell 2
+    """
+
+    expected_message = (
+        r"^Table has a title 'My Table Title', but Notion tables do not "
+        r"have titles.$"
+    )
+    with pytest.raises(expected_exception=ValueError, match=expected_message):
+        _assert_rst_converts_to_notion_objects(
+            rst_content=rst_content,
+            expected_objects=[],
+            make_app=make_app,
+            tmp_path=tmp_path,
+        )