Merge pull request #318 from adamtheturtle/line-block

Add support for line blocks

Author: adamtheturtle

sample/index.rst

@@ -349,3 +349,20 @@ Sphinx ``toctree``\s are hidden
    .. toctree::
 
       other
+
+Line Blocks
+~~~~~~~~~~~~
+
+.. rest-example::
+
+   The builder supports line blocks using pipe characters to preserve line breaks:
+
+   Nothing in between
+
+   |
+
+   Now something in between
+
+   | This is a line block
+   | with multiple lines
+   | preserved exactly as written

src/sphinx_notion/__init__.py

@@ -225,6 +225,15 @@ def _process_rich_text_node(child: nodes.Node) -> Text:
     raise ValueError(unsupported_child_type_msg)
 
 
+@beartype
+@_process_rich_text_node.register
+def _(child: nodes.line) -> Text:
+    """
+    Process line nodes by creating rich text.
+    """
+    return _create_styled_text_from_node(child=child) + "\n"
+
+
 @beartype
 @_process_rich_text_node.register
 def _(child: nodes.reference) -> Text:
@@ -1497,6 +1506,23 @@ def _(
     return []
 
 
+@beartype
+@_process_node_to_blocks.register
+def _(
+    node: nodes.line_block,
+    *,
+    section_level: int,
+) -> list[Block]:
+    """
+    Process line block nodes by creating separate paragraph blocks for each
+    line.
+    """
+    del section_level
+
+    line_text = _create_rich_text_from_children(node=node)
+    return [UnoParagraph(text=line_text)]
+
+
 @beartype
 class NotionTranslator(NodeVisitor):
     """

tests/test_integration.py

@@ -3076,3 +3076,37 @@ def test_embed_and_video(
         # We explain in the README that this is necessary.
         confoverrides={"suppress_warnings": ["app.add_directive"]},
     )
+
+
+def test_line_block(
+    *,
+    make_app: Callable[..., SphinxTestApp],
+    tmp_path: Path,
+) -> None:
+    """
+    Line blocks (created with pipe character) become empty Notion paragraph
+    blocks.
+    """
+    rst_content = """
+        | This is a line block
+        | with multiple lines
+        | preserved exactly as written
+    """
+
+    expected_objects: list[Block] = [
+        UnoParagraph(
+            text=text(text="This is a line block")
+            + text(text="\n")
+            + text(text="with multiple lines")
+            + text(text="\n")
+            + text(text="preserved exactly as written")
+            + text(text="\n")
+        ),
+    ]
+
+    _assert_rst_converts_to_notion_objects(
+        rst_content=rst_content,
+        expected_objects=expected_objects,
+        make_app=make_app,
+        tmp_path=tmp_path,
+    )