typsphinx 0.4.0__tar.gz → 0.4.2__tar.gz

{typsphinx-0.4.0 → typsphinx-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: typsphinx
-Version: 0.4.0
+Version: 0.4.2
 Summary: Sphinx extension for Typst output
 Author-email: Sphinx Typst Contributors <noreply@example.com>
 License-Expression: MIT
@@ -364,5 +364,5 @@ See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
 
 ---
 
-**Status**: Stable (v0.4.0) - Production ready
+**Status**: Stable (v0.4.2) - Production ready
 **Python**: 3.9+ | **Sphinx**: 5.0+ | **Typst**: 0.11.1+

{typsphinx-0.4.0 → typsphinx-0.4.2}/README.md

@@ -319,5 +319,5 @@ See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
 
 ---
 
-**Status**: Stable (v0.4.0) - Production ready
+**Status**: Stable (v0.4.2) - Production ready
 **Python**: 3.9+ | **Sphinx**: 5.0+ | **Typst**: 0.11.1+

{typsphinx-0.4.0 → typsphinx-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "typsphinx"
-version = "0.4.0"
+version = "0.4.2"
 description = "Sphinx extension for Typst output"
 readme = "README.md"
 requires-python = ">=3.9"

{typsphinx-0.4.0 → typsphinx-0.4.2}/tests/test_translator.py

@@ -2416,8 +2416,9 @@ def test_table_cell_colspan(simple_document, mock_builder):
     table.walkabout(translator)
     output = translator.astext()
 
-    # Should have table.cell(colspan: 2)
-    assert "table.cell(colspan: 2)" in output
+    # Should have table.cell with content first, then colspan: 2
+    assert "table.cell(" in output
+    assert "colspan: 2)" in output
     assert "Spans 2 cols" in output
     assert "Col 3" in output
 
@@ -2464,8 +2465,9 @@ def test_table_cell_rowspan(simple_document, mock_builder):
     table.walkabout(translator)
     output = translator.astext()
 
-    # Should have table.cell(rowspan: 2)
-    assert "table.cell(rowspan: 2)" in output
+    # Should have table.cell with content first, then rowspan: 2
+    assert "table.cell(" in output
+    assert "rowspan: 2)" in output
     assert "Spans 2 rows" in output
 
 
@@ -2513,8 +2515,9 @@ def test_table_cell_colspan_and_rowspan(simple_document, mock_builder):
     table.walkabout(translator)
     output = translator.astext()
 
-    # Should have table.cell(colspan: 2, rowspan: 2)
-    assert "table.cell(colspan: 2, rowspan: 2)" in output
+    # Should have table.cell with content first, then colspan and rowspan
+    assert "table.cell(" in output
+    assert "colspan: 2, rowspan: 2)" in output
     assert "Spans 2x2" in output
 
 
@@ -2573,7 +2576,8 @@ def test_table_header_cell_with_colspan(simple_document, mock_builder):
 
     # Should have table.header() with colspan cell
     assert "table.header(" in output
-    assert "table.cell(colspan: 2)" in output
+    assert "table.cell(" in output
+    assert "colspan: 2)" in output
     assert "Header 1-2" in output
     assert "Header 3" in output
 
@@ -2618,6 +2622,221 @@ def test_table_normal_cells_without_spanning(simple_document, mock_builder):
     assert "Cell 2" in output
 
 
+# Empty table cell tests (Issue #68)
+
+
+def test_table_empty_cells(simple_document, mock_builder):
+    """Test that empty table cells are wrapped in content blocks.
+
+    Related to Issue #68: Empty table cells cause Typst compilation errors.
+    Empty cells should be wrapped in {} to generate valid Typst syntax.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Create table with all empty cells
+    table = nodes.table()
+    tgroup = nodes.tgroup(cols=2)
+    tgroup += nodes.colspec(colwidth=1)
+    tgroup += nodes.colspec(colwidth=1)
+
+    tbody = nodes.tbody()
+    row1 = nodes.row()
+    entry1 = nodes.entry()  # Empty cell
+    entry2 = nodes.entry()  # Empty cell
+    row1 += entry1
+    row1 += entry2
+    tbody += row1
+    tgroup += tbody
+    table += tgroup
+
+    table.walkabout(translator)
+    output = translator.astext()
+
+    # Should contain empty content blocks
+    assert "{}" in output
+    # Should NOT contain bare commas
+    assert ",," not in output
+    assert "  ,\n" not in output
+
+
+def test_table_mixed_empty_and_content(simple_document, mock_builder):
+    """Test table with both empty and non-empty cells.
+
+    Related to Issue #68: Empty table cells cause Typst compilation errors.
+    Tables with mixed empty and non-empty cells should generate valid Typst syntax.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Create table: A | (empty) / (empty) | D
+    table = nodes.table()
+    tgroup = nodes.tgroup(cols=2)
+    tgroup += nodes.colspec(colwidth=1)
+    tgroup += nodes.colspec(colwidth=1)
+
+    tbody = nodes.tbody()
+
+    # Row 1: A | empty
+    row1 = nodes.row()
+    entry1 = nodes.entry()
+    entry1 += nodes.paragraph(text="A")
+    entry2 = nodes.entry()  # Empty
+    row1 += entry1
+    row1 += entry2
+    tbody += row1
+
+    # Row 2: empty | D
+    row2 = nodes.row()
+    entry3 = nodes.entry()  # Empty
+    entry4 = nodes.entry()
+    entry4 += nodes.paragraph(text="D")
+    row2 += entry3
+    row2 += entry4
+    tbody += row2
+
+    tgroup += tbody
+    table += tgroup
+
+    table.walkabout(translator)
+    output = translator.astext()
+
+    # Should contain content for non-empty cells
+    assert "A" in output
+    assert "D" in output
+    # Should contain empty content blocks
+    assert "{}" in output
+    # Should NOT contain bare commas
+    assert ",," not in output
+
+
+def test_table_empty_colspan_cells(simple_document, mock_builder):
+    """Test that empty cells with colspan use table.cell with empty content.
+
+    Related to Issue #68: Empty table cells cause Typst compilation errors.
+    Empty cells with colspan should use table.cell({}, colspan: N) syntax.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Create table with empty colspan cell
+    table = nodes.table()
+    tgroup = nodes.tgroup(cols=2)
+    tgroup += nodes.colspec(colwidth=1)
+    tgroup += nodes.colspec(colwidth=1)
+
+    tbody = nodes.tbody()
+    row1 = nodes.row()
+
+    # Empty cell with colspan=2
+    entry1 = nodes.entry(morecols=1)  # Empty, spans 2 columns
+    row1 += entry1
+    tbody += row1
+    tgroup += tbody
+    table += tgroup
+
+    table.walkabout(translator)
+    output = translator.astext()
+
+    # Should use table.cell with empty content
+    assert "table.cell({}" in output
+    assert "colspan: 2" in output
+    # Should NOT contain bare commas or missing content
+    assert "table.cell(," not in output
+
+
+def test_table_empty_rowspan_cells(simple_document, mock_builder):
+    """Test that empty cells with rowspan use table.cell with empty content.
+
+    Related to Issue #68: Empty table cells cause Typst compilation errors.
+    Empty cells with rowspan should use table.cell({}, rowspan: N) syntax.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Create table with empty rowspan cell
+    table = nodes.table()
+    tgroup = nodes.tgroup(cols=2)
+    tgroup += nodes.colspec(colwidth=1)
+    tgroup += nodes.colspec(colwidth=1)
+
+    tbody = nodes.tbody()
+    row1 = nodes.row()
+
+    # Empty cell with rowspan=2
+    entry1 = nodes.entry(morerows=1)  # Empty, spans 2 rows
+    entry2 = nodes.entry()
+    entry2 += nodes.paragraph(text="B")
+    row1 += entry1
+    row1 += entry2
+    tbody += row1
+
+    # Row 2
+    row2 = nodes.row()
+    entry3 = nodes.entry()
+    entry3 += nodes.paragraph(text="C")
+    row2 += entry3
+    tbody += row2
+
+    tgroup += tbody
+    table += tgroup
+
+    table.walkabout(translator)
+    output = translator.astext()
+
+    # Should use table.cell with empty content
+    assert "table.cell({}" in output
+    assert "rowspan: 2" in output
+    # Should NOT contain bare commas or missing content
+    assert "table.cell(," not in output
+
+
+def test_table_empty_colspan_rowspan_cells(simple_document, mock_builder):
+    """Test that empty cells with both colspan and rowspan use table.cell with empty content.
+
+    Related to Issue #68: Empty table cells cause Typst compilation errors.
+    Empty cells with both colspan and rowspan should use table.cell({}, colspan: M, rowspan: N) syntax.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Create table with empty colspan+rowspan cell
+    table = nodes.table()
+    tgroup = nodes.tgroup(cols=2)
+    tgroup += nodes.colspec(colwidth=1)
+    tgroup += nodes.colspec(colwidth=1)
+
+    tbody = nodes.tbody()
+    row1 = nodes.row()
+
+    # Empty cell with colspan=2, rowspan=2
+    entry1 = nodes.entry(morecols=1, morerows=1)  # Empty, spans 2x2
+    row1 += entry1
+    tbody += row1
+
+    # Row 2 (no cells needed due to spanning)
+    row2 = nodes.row()
+    tbody += row2
+
+    tgroup += tbody
+    table += tgroup
+
+    table.walkabout(translator)
+    output = translator.astext()
+
+    # Should use table.cell with empty content
+    assert "table.cell({}" in output
+    assert "colspan: 2" in output
+    assert "rowspan: 2" in output
+    # Should NOT contain bare commas or missing content
+    assert "table.cell(," not in output
+
+
 # API description nodes tests (Issue #55)
 
 
@@ -2854,3 +3073,148 @@ def test_full_api_description_structure(simple_document, mock_builder):
     assert "Builder class for Typst output." in output
     assert 'strong(text("Parameters")' in output or "Parameters" in output
     assert "app - Sphinx application" in output
+
+
+# Image path adjustment tests (Issue #69)
+
+
+def test_image_path_adjustment_root(simple_document, mock_builder):
+    """Test that root document image paths are not adjusted.
+
+    Related to Issue #69: Image paths in root documents should remain unchanged.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Set current_docname to root document
+    mock_builder.current_docname = "index"
+
+    # Create image node
+    image = nodes.image(uri="images/logo.png")
+    image["width"] = "200px"
+
+    image.walkabout(translator)
+    output = translator.astext()
+
+    # Root document: path should NOT be adjusted
+    assert 'image("images/logo.png"' in output
+    assert "../images" not in output
+    assert "width: 200px" in output
+
+
+def test_image_path_adjustment_nested(simple_document, mock_builder):
+    """Test that nested document image paths are adjusted with ../ prefix.
+
+    Related to Issue #69: Nested documents need relative path adjustment.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Set current_docname to nested document
+    mock_builder.current_docname = "chapter1/section1"
+
+    # Create image node with source-root-relative path
+    image = nodes.image(uri="images/logo.png")
+    image["width"] = "200px"
+
+    image.walkabout(translator)
+    output = translator.astext()
+
+    # Nested document: path should be adjusted
+    assert 'image("../images/logo.png"' in output
+    assert "width: 200px" in output
+
+
+def test_image_path_adjustment_deep_nested(simple_document, mock_builder):
+    """Test that deeply nested documents get correct number of ../ prefixes.
+
+    Related to Issue #69: Deep nesting requires multiple ../ levels.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Set current_docname to deeply nested document
+    mock_builder.current_docname = "part1/chapter1/section1"
+
+    # Create image node
+    image = nodes.image(uri="images/logo.png")
+
+    image.walkabout(translator)
+    output = translator.astext()
+
+    # Deeply nested: should have ../../ prefix
+    assert 'image("../../images/logo.png"' in output
+
+
+def test_image_path_adjustment_cross_directory(simple_document, mock_builder):
+    """Test that cross-directory image references are correctly adjusted.
+
+    Related to Issue #69: References from chapter1/ to chapter2/ images.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Set current document in chapter1
+    mock_builder.current_docname = "chapter1/section1"
+
+    # Reference image in chapter2
+    image = nodes.image(uri="chapter2/images/diagram.png")
+
+    image.walkabout(translator)
+    output = translator.astext()
+
+    # Cross-directory: ../chapter2/images/diagram.png
+    assert 'image("../chapter2/images/diagram.png"' in output
+
+
+def test_image_path_adjustment_same_directory(simple_document, mock_builder):
+    """Test that same-directory images use simple relative paths.
+
+    Related to Issue #69: Images in the same directory as the document.
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Both in chapter1/
+    mock_builder.current_docname = "chapter1/section1"
+
+    # Image also in chapter1/
+    image = nodes.image(uri="chapter1/local-image.png")
+
+    image.walkabout(translator)
+    output = translator.astext()
+
+    # Same directory: just the filename
+    assert 'image("local-image.png"' in output
+    assert "../" not in output
+
+
+def test_image_path_adjustment_subdirectory(simple_document, mock_builder):
+    """Test that subdirectory images use relative paths to child folders.
+
+    Related to Issue #69: Images in subdirectories relative to the document.
+    Example: chapter1/section1.rst references chapter1/img/diagram.jpeg
+    """
+    from typsphinx.translator import TypstTranslator
+
+    translator = TypstTranslator(simple_document, mock_builder)
+
+    # Document in chapter1/
+    mock_builder.current_docname = "chapter1/section1"
+
+    # Image in chapter1/img/ (subdirectory of same directory)
+    image = nodes.image(uri="chapter1/img/diagram.jpeg")
+    image["width"] = "250px"
+
+    image.walkabout(translator)
+    output = translator.astext()
+
+    # Subdirectory: img/diagram.jpeg (relative to current directory)
+    assert 'image("img/diagram.jpeg"' in output
+    assert "width: 250px" in output
+    assert "../" not in output  # No need to go up

{typsphinx-0.4.0 → typsphinx-0.4.2}/typsphinx/__init__.py

@@ -11,7 +11,7 @@ sources using Sphinx, which can then be compiled to PDF using the Typst compiler
 :license: MIT, see LICENSE for details.
 """
 
-__version__ = "0.3.0"
+__version__ = "0.4.1"
 __author__ = "Sphinx Typst Contributors"
 
 from typing import Any, Dict

{typsphinx-0.4.0 → typsphinx-0.4.2}/typsphinx/translator.py

@@ -1215,7 +1215,7 @@ class TypstTranslator(SphinxTranslator):
 
         # Normal cell (no spanning)
         if colspan == 1 and rowspan == 1:
-            return f"{indent}[{content}],\n"
+            return f"{indent}{{{content}}},\n"
 
         # Cell with spanning - use table.cell()
         params = []
@@ -1225,7 +1225,7 @@ class TypstTranslator(SphinxTranslator):
             params.append(f"rowspan: {rowspan}")
 
         params_str = ", ".join(params)
-        return f"{indent}table.cell({params_str})[{content}],\n"
+        return f"{indent}table.cell({{{content}}}, {params_str}),\n"
 
     def depart_table(self, node: nodes.table) -> None:
         """
@@ -1464,18 +1464,25 @@ class TypstTranslator(SphinxTranslator):
         Visit an image node.
 
         Generates image() function call (no # prefix in code mode).
+        Adjusts image paths for nested documents (Issue #69).
 
         Args:
             node: The image node
         """
         uri = node.get("uri", "")
 
+        # Get current document name for path adjustment (Issue #69)
+        current_docname = getattr(self.builder, "current_docname", None)
+
+        # Adjust path based on output file location (Issue #69)
+        adjusted_uri = self._compute_relative_image_path(uri, current_docname)
+
         # Add proper indentation if inside a figure
         if self.in_figure:
-            self.add_text(f'  image("{uri}"')
+            self.add_text(f'  image("{adjusted_uri}"')
         else:
             # No # prefix in code mode
-            self.add_text(f'image("{uri}"')
+            self.add_text(f'image("{adjusted_uri}"')
 
         # Add optional attributes
         if "width" in node:
@@ -1699,6 +1706,111 @@ class TypstTranslator(SphinxTranslator):
 
             return relative_path
 
+    def _compute_relative_image_path(
+        self, image_uri: str, current_docname: Optional[str]
+    ) -> str:
+        """
+        Compute relative path for image() function.
+
+        Adjusts image URIs from source-root-relative to output-file-relative.
+        This is similar to _compute_relative_include_path() but for images.
+
+        Args:
+            image_uri: Image URI from Sphinx (source-root-relative)
+            current_docname: Current document name (e.g., "chapter1/section1")
+
+        Returns:
+            Adjusted relative path for Typst image()
+
+        Examples:
+            >>> _compute_relative_image_path("images/logo.png", "chapter1/section1")
+            "../images/logo.png"
+            >>> _compute_relative_image_path("images/logo.png", "index")
+            "images/logo.png"
+            >>> _compute_relative_image_path("images/logo.png", None)
+            "images/logo.png"
+
+        Notes:
+            This implements Issue #69 fix for nested document image paths.
+            Uses the same logic as _compute_relative_include_path() from Issue #5.
+        """
+        from pathlib import PurePosixPath
+
+        logger.debug(
+            f"Computing relative image path: uri={image_uri}, "
+            f"current={current_docname}"
+        )
+
+        # Fallback to absolute path if current_docname is None
+        if not current_docname:
+            logger.debug(f"No current document, using absolute path: {image_uri}")
+            return image_uri
+
+        current_path = PurePosixPath(current_docname)
+        image_path = PurePosixPath(image_uri)
+        current_dir = current_path.parent
+
+        logger.debug(
+            f"Path components: current_dir={current_dir}, image_path={image_path}"
+        )
+
+        # Root directory case: use absolute path (backward compatibility)
+        if current_dir == PurePosixPath("."):
+            logger.debug(
+                f"Current document is in root directory, "
+                f"using absolute path: {image_uri}"
+            )
+            return image_uri
+
+        # Try to compute relative path
+        try:
+            rel_path = image_path.relative_to(current_dir)
+            result = str(rel_path)
+            logger.debug(
+                f"Same directory reference: {current_dir} -> {image_path}, "
+                f"result: {result}"
+            )
+            return result
+        except ValueError:
+            # Different directory trees - build path via common parent
+            logger.debug(
+                "Cross-directory reference detected, calculating via common parent"
+            )
+
+            current_parts = current_dir.parts
+            image_parts = image_path.parts
+
+            # Find common parent by comparing path components
+            common_length = 0
+            for i, (c, img) in enumerate(zip(current_parts, image_parts)):
+                if c == img:
+                    common_length = i + 1
+                else:
+                    break
+
+            logger.debug(
+                f"Common parent depth: {common_length}, "
+                f"current_parts={current_parts}, image_parts={image_parts}"
+            )
+
+            # Build path: "../" from current to common parent
+            up_count = len(current_parts) - common_length
+            up_path = "../" * up_count if up_count > 0 else ""
+
+            # Build path: from common parent to image
+            down_parts = image_parts[common_length:]
+            down_path = "/".join(down_parts) if down_parts else ""
+
+            relative_path: str = up_path + down_path
+
+            logger.debug(
+                f"Cross-directory path calculation: up_count={up_count}, "
+                f"up_path='{up_path}', down_path='{down_path}', "
+                f"result: {relative_path}"
+            )
+
+            return relative_path
+
     def visit_toctree(self, node: nodes.Node) -> None:
         """
         Visit a toctree node (Sphinx table of contents tree).

{typsphinx-0.4.0 → typsphinx-0.4.2}/typsphinx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: typsphinx
-Version: 0.4.0
+Version: 0.4.2
 Summary: Sphinx extension for Typst output
 Author-email: Sphinx Typst Contributors <noreply@example.com>
 License-Expression: MIT
@@ -364,5 +364,5 @@ See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
 
 ---
 
-**Status**: Stable (v0.4.0) - Production ready
+**Status**: Stable (v0.4.2) - Production ready
 **Python**: 3.9+ | **Sphinx**: 5.0+ | **Typst**: 0.11.1+