sphinx-examples-as-code 0.5.0__tar.gz → 0.6.1__tar.gz

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/.github/workflows/ci.yml

@@ -22,10 +22,10 @@ jobs:
       with:
         persist-credentials: false
         fetch-depth: 0
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9   # v9.0.0
+    - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4   # v10.1.0
       with:
         enable-cache: false
-    - run: uv sync --group dev
+    - run: uv sync --group dev --extra gallery
     - run: uv run pre-commit run --all-files --show-diff-on-failure
       env:
           # This hook exists to stop *local* commits straight to main; it
@@ -43,13 +43,13 @@ jobs:
       with:
         persist-credentials: false
         fetch-depth: 0
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9   # v9.0.0
+    - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4   # v10.1.0
       with:
         enable-cache: false
-    - uses: pyvista/setup-headless-display-action@5bc8de3bc71fcda7a96439571287a554901541a0   # v4.3
+    - uses: pyvista/setup-headless-display-action@c103a2ff45650d38cb71684b5dc6cdfeb9442c79   # v5.1.0
       with:
         pyvista: true
-    - run: uv sync --group dev --python ${{ matrix.python-version }}
+    - run: uv sync --group dev --extra gallery --python ${{ matrix.python-version }}
     - run: uv run pytest tests/ --cov --cov-report=xml
     - uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f   # v7.0.0
       with:
@@ -65,7 +65,7 @@ jobs:
       with:
         persist-credentials: false
         fetch-depth: 0
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9   # v9.0.0
+    - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4   # v10.1.0
       with:
         enable-cache: false
     - run: uv build

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-examples-as-code
-Version: 0.5.0
+Version: 0.6.1
 Summary: Sphinx extension for converting docstring examples into downloadable code.
 Author-email: The PyVista Developers <info@pyvista.org>
 License-Expression: MIT
@@ -23,6 +23,8 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyvista>=0.48
+Provides-Extra: gallery
+Requires-Dist: sphinx-gallery<0.23,>=0.22; extra == "gallery"
 Dynamic: license-file
 
 # sphinx-examples-as-code
@@ -39,6 +41,13 @@ Pages or docstrings without an Examples section are left completely untouched. A
 pip install sphinx-examples-as-code
 ```
 
+Sphinx-Gallery integration is opt-in and needs a compatible sphinx-gallery, which the
+`gallery` extra pins:
+
+```bash
+pip install 'sphinx-examples-as-code[gallery]'
+```
+
 Add it to your Sphinx `conf.py`:
 
 ```python
@@ -123,6 +132,10 @@ What happens to the content of an Examples section:
   backticks.
 - Everything else text-bearing (prose, captions, other non-Python code) becomes a plain
   `#` comment.
+- A table becomes an aligned text table, its caption on the line above: an RST simple
+  table in `.py`, a Markdown pipe table in `.ipynb`. Each cell is flattened to a single
+  line, and a column left entirely empty -- one holding only images, say -- is dropped
+  along with its heading.
 - Figures/images, raw HTML, sphinx-design dropdowns/tab-sets, and sphinx-tags' `.. tags::`
   line are dropped entirely.
 - "See Also" content is always dropped.
@@ -175,16 +188,18 @@ styles:
 
 Two things worth knowing before turning this on:
 
-- It's built against sphinx-gallery's own RST/HTML output (the same `sphx-glr-*` CSS
-  classes its own theming depends on), not a documented extension API. A future
-  sphinx-gallery release could shift that structure without warning.
+- It's built against sphinx-gallery's own doctree output — the `sphx-glr-*` CSS classes
+  its own theming depends on, and the private node type holding a highlighted code
+  block — not a documented extension API. A future sphinx-gallery release could shift
+  that structure without warning. Only sphinx-gallery 0.22.x is tested, so the `gallery`
+  extra caps there rather than letting the next release quietly produce no downloads.
 - sphinx-gallery's own `.py`/`.ipynb`/`.zip` downloads still end up copied into
   `_downloads/`, even though nothing on the page links to them anymore.
 
 ## Development
 
 ```bash
-uv sync --group dev
+uv sync --group dev --extra gallery
 uv run pytest
 uv run pre-commit run --all-files
 ```

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/README.md

@@ -12,6 +12,13 @@ Pages or docstrings without an Examples section are left completely untouched. A
 pip install sphinx-examples-as-code
 ```
 
+Sphinx-Gallery integration is opt-in and needs a compatible sphinx-gallery, which the
+`gallery` extra pins:
+
+```bash
+pip install 'sphinx-examples-as-code[gallery]'
+```
+
 Add it to your Sphinx `conf.py`:
 
 ```python
@@ -96,6 +103,10 @@ What happens to the content of an Examples section:
   backticks.
 - Everything else text-bearing (prose, captions, other non-Python code) becomes a plain
   `#` comment.
+- A table becomes an aligned text table, its caption on the line above: an RST simple
+  table in `.py`, a Markdown pipe table in `.ipynb`. Each cell is flattened to a single
+  line, and a column left entirely empty -- one holding only images, say -- is dropped
+  along with its heading.
 - Figures/images, raw HTML, sphinx-design dropdowns/tab-sets, and sphinx-tags' `.. tags::`
   line are dropped entirely.
 - "See Also" content is always dropped.
@@ -148,16 +159,18 @@ styles:
 
 Two things worth knowing before turning this on:
 
-- It's built against sphinx-gallery's own RST/HTML output (the same `sphx-glr-*` CSS
-  classes its own theming depends on), not a documented extension API. A future
-  sphinx-gallery release could shift that structure without warning.
+- It's built against sphinx-gallery's own doctree output — the `sphx-glr-*` CSS classes
+  its own theming depends on, and the private node type holding a highlighted code
+  block — not a documented extension API. A future sphinx-gallery release could shift
+  that structure without warning. Only sphinx-gallery 0.22.x is tested, so the `gallery`
+  extra caps there rather than letting the next release quietly produce no downloads.
 - sphinx-gallery's own `.py`/`.ipynb`/`.zip` downloads still end up copied into
   `_downloads/`, even though nothing on the page links to them anymore.
 
 ## Development
 
 ```bash
-uv sync --group dev
+uv sync --group dev --extra gallery
 uv run pytest
 uv run pre-commit run --all-files
 ```

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/pyproject.toml

@@ -11,7 +11,6 @@ dev = [
   'pytest-cov',
   'sphinx',
   'sphinx-design',
-  'sphinx-gallery>=0.21.0',
   'trame-pyvista',
 ]
 
@@ -41,6 +40,9 @@ name = 'sphinx-examples-as-code'
 readme = 'README.md'
 requires-python = '>=3.10'
 
+[project.optional-dependencies]
+gallery = ['sphinx-gallery>=0.22,<0.23']
+
 [project.urls]
 Homepage = 'https://github.com/pyvista/sphinx-examples-as-code'
 

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code/__init__.py

@@ -91,6 +91,22 @@ _ADMONITION_LABELS = {
 
 _PYTHON_LANGUAGES = ('python', 'py', 'python3')
 
+# sphinx-gallery's own node type for a gallery example's Python code, in
+# place of a ``literal_block``: one child per pygments token, so that names
+# in the code can carry links to their documentation. Its language is spelled
+# ``lang``, and its source has to be read back off its children. Code in any
+# other language stays an ordinary ``literal_block``.
+#
+# Matched by tag name rather than by ``isinstance``: sphinx-gallery is not a
+# dependency of this extension (gallery support is opt-in via
+# ``gallery_downloads``), so the class itself can't be imported here.
+_GALLERY_CODE_BLOCK_TAGNAME = 'code_links_block'
+
+# Class on the ``inline`` nodes sphinx-gallery interleaves into the above when
+# the block has line numbers turned on. Rendering furniture, not source, so
+# they're dropped rather than baked into the generated file.
+_GALLERY_LINENOS_CLASS = 'linenos'
+
 # A chunk of generated lines tagged with how it should be spaced relative to
 # its neighbors when segments are joined (see ``_join_segments``):
 #   'code'      real Python source
@@ -319,16 +335,34 @@ def _convert_doctest_block(node: nodes.doctest_block) -> list[Segment]:
     return [('code', lines)]
 
 
-def _convert_literal_block(node: nodes.literal_block) -> list[Segment]:
+def _is_gallery_code_block(node: nodes.Node) -> bool:
+    """Check whether ``node`` is the node type sphinx-gallery puts example code in."""
+    return getattr(node, 'tagname', None) == _GALLERY_CODE_BLOCK_TAGNAME
+
+
+def _gallery_code_block_source(node: nodes.Element) -> str:
+    """Reassemble the source text sphinx-gallery split across per-token nodes."""
+    # One child per pygments token (some wrapped in a reference node), which
+    # ``astext()`` joins back together with no separator -- apart from the
+    # line-number nodes, which were never part of the source.
+    return ''.join(
+        child.astext() for child in node.children if not _has_class(child, _GALLERY_LINENOS_CLASS)
+    )
+
+
+def _convert_literal_block(node: nodes.Element) -> list[Segment]:
     """Convert a ``.. code-block::``. Python blocks stay code, others become comments."""
-    language = node.get('language', '')
+    if _is_gallery_code_block(node):
+        language, source = node.get('lang', ''), _gallery_code_block_source(node)
+    else:
+        language, source = node.get('language', ''), node.astext()
     # Case-insensitive: sphinx-gallery emits ``.. code-block:: Python`` (capitalized).
     if language.lower() in _PYTHON_LANGUAGES:
-        lines = [_clean_code_comment(line) for line in node.astext().splitlines()]
+        lines = [_clean_code_comment(line) for line in source.splitlines()]
         while lines and not lines[-1].strip():
             lines.pop()
         return [('code', lines)] if lines else []
-    text = node.astext().strip()
+    text = source.strip()
     if not text:
         return []
     comment_lines: list[str] = []
@@ -474,6 +508,116 @@ def _list_segment(
     return [('directive', lines)] if lines else []
 
 
+#: Narrowest a generated table column may be, per format.
+_TABLE_MIN_WIDTH = {'py': 1, 'ipynb': 3}
+
+
+def _table_cell_text(entry: nodes.entry, ctx: _RenderContext) -> str:
+    """Render one cell's content as a single line, list items separated by ``;``."""
+    parts: list[str] = []
+    for child in entry.children:
+        if isinstance(child, (nodes.bullet_list, nodes.enumerated_list)):
+            items = (_render_inline(item, ctx).strip() for item in child.children)
+            parts.append('; '.join(item for item in items if item))
+        else:
+            parts.append(_render_inline(child, ctx).strip())
+    return ' '.join(part for part in parts if part)
+
+
+def _table_rows(group: nodes.Element, ctx: _RenderContext) -> list[list[str]]:
+    """Render a ``thead``/``tbody``'s rows, padding a column-spanning cell with empties."""
+    rows: list[list[str]] = []
+    for row in group.children:
+        cells: list[str] = []
+        for entry in row.children:
+            cells.append(_table_cell_text(entry, ctx))
+            cells.extend([''] * entry.get('morecols', 0))
+        if any(cells):
+            rows.append(cells)
+    return rows
+
+
+def _table_grid(node: nodes.table, ctx: _RenderContext) -> tuple[list[list[str]], list[list[str]]]:
+    """Split a table into header rows and body rows, dropping any column left empty."""
+    head: list[list[str]] = []
+    body: list[list[str]] = []
+    for tgroup in node.children:
+        if not isinstance(tgroup, nodes.tgroup):
+            continue
+        for group in tgroup.children:
+            if isinstance(group, nodes.thead):
+                head.extend(_table_rows(group, ctx))
+            elif isinstance(group, nodes.tbody):
+                body.extend(_table_rows(group, ctx))
+    columns = max((len(row) for row in [*head, *body]), default=0)
+    for row in [*head, *body]:
+        row.extend([''] * (columns - len(row)))
+    filled = [index for index in range(columns) if any(row[index] for row in body)]
+    if not filled or len(filled) == columns:
+        return head, body
+    return (
+        [[row[index] for index in filled] for row in head],
+        [[row[index] for index in filled] for row in body],
+    )
+
+
+def _table_widths(rows: list[list[str]], minimum: int) -> list[int]:
+    """Measure each column, never narrower than ``minimum``."""
+    return [max(minimum, *map(len, column)) for column in zip(*rows, strict=True)]
+
+
+def _markdown_table_lines(head: list[list[str]], body: list[list[str]]) -> list[str]:
+    """Render rows as a Markdown pipe table, with a blank header row if there is none."""
+    head = [[cell.replace('|', r'\|') for cell in row] for row in head]
+    body = [[cell.replace('|', r'\|') for cell in row] for row in body]
+    widths = _table_widths([*head, *body], _TABLE_MIN_WIDTH['ipynb'])
+
+    def render(cells: list[str]) -> str:
+        padded = (cell.ljust(width) for cell, width in zip(cells, widths, strict=True))
+        return f'| {" | ".join(padded)} |'
+
+    header, *extra = head or [[''] * len(widths)]
+    divider = f'| {" | ".join("-" * width for width in widths)} |'
+    return [render(header), divider, *(render(cells) for cells in [*extra, *body])]
+
+
+def _simple_table_lines(head: list[list[str]], body: list[list[str]]) -> list[str]:
+    """Render rows as an RST simple table, bordered above, below and under its header."""
+    widths = _table_widths([*head, *body], _TABLE_MIN_WIDTH['py'])
+    border = '  '.join('=' * width for width in widths)
+
+    def render(cells: list[str]) -> str:
+        return '  '.join(
+            cell.ljust(width) for cell, width in zip(cells, widths, strict=True)
+        ).rstrip()
+
+    lines = [border]
+    for rows in (head, body):
+        if rows:
+            lines.extend(render(cells) for cells in rows)
+            lines.append(border)
+    return lines
+
+
+def _table_segment(node: nodes.table, ctx: _RenderContext) -> list[Segment]:
+    """Convert a table to an RST simple table in ``.py``, a Markdown one in ``.ipynb``.
+
+    Each cell is flattened to a single line, the caption sits above.
+    """
+    head, body = _table_grid(node, ctx)
+    if not head and not body:
+        return []
+    lines: list[str] = []
+    caption = next((child for child in node.children if isinstance(child, nodes.title)), None)
+    if caption is not None and (text := _render_inline(caption, ctx).strip()):
+        _add_comment(lines, text)
+        lines.append('#')
+    render = _markdown_table_lines if ctx.fmt == 'ipynb' else _simple_table_lines
+    for line in render(head, body):
+        _add_comment(lines, line)
+    return [('directive', lines)]
+
+
 def _convert_admonition(
     node: nodes.Element, label: str, ctx: _RenderContext, *, skip_first_title: bool = False
 ) -> list[Segment]:
@@ -495,7 +639,7 @@ def _convert_node(node: nodes.Node, ctx: _RenderContext) -> list[Segment]:
         return []
     if isinstance(node, nodes.doctest_block):
         return _convert_doctest_block(node)
-    if isinstance(node, nodes.literal_block):
+    if isinstance(node, nodes.literal_block) or _is_gallery_code_block(node):
         return _convert_literal_block(node)
     if type(node) in _ADMONITION_LABELS:
         if _is_see_also_type(node):
@@ -527,6 +671,8 @@ def _convert_node(node: nodes.Node, ctx: _RenderContext) -> list[Segment]:
         return _definition_segment(node, ctx)
     if isinstance(node, (nodes.bullet_list, nodes.enumerated_list)):
         return _list_segment(node, ctx)
+    if isinstance(node, nodes.table):
+        return _table_segment(node, ctx)
     if isinstance(node, (*_CONTAINER_TYPES, nodes.section)):
         # nodes.section (gallery mode only): a sphinx-gallery ``# %%`` cell
         # with its own RST heading is a *sibling* section at the document

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.5.0'
-__version_tuple__ = version_tuple = (0, 5, 0)
+__version__ = version = '0.6.1'
+__version_tuple__ = version_tuple = (0, 6, 1)
 
-__commit_id__ = commit_id = 'g7bd70a33e'
+__commit_id__ = commit_id = 'ge9f0565b9'

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-examples-as-code
-Version: 0.5.0
+Version: 0.6.1
 Summary: Sphinx extension for converting docstring examples into downloadable code.
 Author-email: The PyVista Developers <info@pyvista.org>
 License-Expression: MIT
@@ -23,6 +23,8 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyvista>=0.48
+Provides-Extra: gallery
+Requires-Dist: sphinx-gallery<0.23,>=0.22; extra == "gallery"
 Dynamic: license-file
 
 # sphinx-examples-as-code
@@ -39,6 +41,13 @@ Pages or docstrings without an Examples section are left completely untouched. A
 pip install sphinx-examples-as-code
 ```
 
+Sphinx-Gallery integration is opt-in and needs a compatible sphinx-gallery, which the
+`gallery` extra pins:
+
+```bash
+pip install 'sphinx-examples-as-code[gallery]'
+```
+
 Add it to your Sphinx `conf.py`:
 
 ```python
@@ -123,6 +132,10 @@ What happens to the content of an Examples section:
   backticks.
 - Everything else text-bearing (prose, captions, other non-Python code) becomes a plain
   `#` comment.
+- A table becomes an aligned text table, its caption on the line above: an RST simple
+  table in `.py`, a Markdown pipe table in `.ipynb`. Each cell is flattened to a single
+  line, and a column left entirely empty -- one holding only images, say -- is dropped
+  along with its heading.
 - Figures/images, raw HTML, sphinx-design dropdowns/tab-sets, and sphinx-tags' `.. tags::`
   line are dropped entirely.
 - "See Also" content is always dropped.
@@ -175,16 +188,18 @@ styles:
 
 Two things worth knowing before turning this on:
 
-- It's built against sphinx-gallery's own RST/HTML output (the same `sphx-glr-*` CSS
-  classes its own theming depends on), not a documented extension API. A future
-  sphinx-gallery release could shift that structure without warning.
+- It's built against sphinx-gallery's own doctree output — the `sphx-glr-*` CSS classes
+  its own theming depends on, and the private node type holding a highlighted code
+  block — not a documented extension API. A future sphinx-gallery release could shift
+  that structure without warning. Only sphinx-gallery 0.22.x is tested, so the `gallery`
+  extra caps there rather than letting the next release quietly produce no downloads.
 - sphinx-gallery's own `.py`/`.ipynb`/`.zip` downloads still end up copied into
   `_downloads/`, even though nothing on the page links to them anymore.
 
 ## Development
 
 ```bash
-uv sync --group dev
+uv sync --group dev --extra gallery
 uv run pytest
 uv run pre-commit run --all-files
 ```

sphinx_examples_as_code-0.6.1/sphinx_examples_as_code.egg-info/requires.txt

@@ -0,0 +1,4 @@
+pyvista>=0.48
+
+[gallery]
+sphinx-gallery<0.23,>=0.22

sphinx_examples_as_code-0.6.1/sphinx_examples_as_code.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.6.1",
+  "distance": 0,
+  "node": "ge9f0565b9b658b5a3927b2ef0deae82a4108696d",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-22"
+}

sphinx_examples_as_code-0.6.1/tests/gallery_fixture/index.rst

@@ -0,0 +1,17 @@
+Gallery Downloads Fixture
+=========================
+
+.. toctree::
+    :maxdepth: 2
+
+    auto_examples/index
+
+.. Documented purely so that sphinx-gallery has something to link the example's
+   code to: it wraps every name it resolves in a reference, and ``x``/``y``/``z``
+   are inferred as ``builtins.int``, which resolves to this entry (a builtin is
+   looked up under its bare name). Without it the code these tests stitch back
+   together never takes its linked shape.
+
+.. py:class:: int
+
+    Stand-in for the builtin, so the example's integers resolve to something.

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/tests/test_sphinx_examples_as_code.py

@@ -16,6 +16,7 @@ from docutils.core import publish_doctree
 import pytest
 from sphinx import addnodes
 from sphinx.errors import ConfigError
+from sphinx_gallery._doctree_links import code_links_block
 
 import sphinx_examples_as_code as seac
 
@@ -389,6 +390,94 @@ def test_convert_literal_block_python_whitespace_only():
     assert seac._convert_literal_block(node) == []
 
 
+# ---------------------------------------------------------------------------
+# _convert_literal_block: sphinx-gallery's own code-block node
+# ---------------------------------------------------------------------------
+
+
+def _token(text: str, css_class: str | None = None) -> nodes.Node:
+    """Build one pygments token, as sphinx-gallery emits it.
+
+    A classified token becomes an ``inline`` carrying the pygments short
+    class; the root token type is left unwrapped, as bare text.
+    """
+    if css_class is None:
+        return nodes.Text(text)
+    return nodes.inline(text, text, classes=[css_class])
+
+
+def _linked_token(text: str, css_class: str) -> nodes.reference:
+    """Build a name sphinx-gallery resolved to a documented object, so wrapped in a link."""
+    return nodes.reference('', '', _token(text, css_class), refuri='index.html#int')
+
+
+def _gallery_code_block(*children: nodes.Node, lang: str = 'Python') -> nodes.Element:
+    """Build one of sphinx-gallery's tokenized code blocks out of ``children``."""
+    node = code_links_block(lang=lang)
+    node += list(children)
+    return node
+
+
+def test_gallery_code_block_contract():
+    """Pin down what the extension assumes about sphinx-gallery's own node.
+
+    It is private to sphinx-gallery, and it replaces every Python code block
+    on a gallery page before this extension ever sees the doctree -- so a
+    change to any of these three leaves each example a block of comments
+    with no download link at all. Asserted here, where a failure names the
+    assumption that moved, rather than only surfacing further downstream as
+    a mangled download.
+    """
+    node = code_links_block(lang='Python')
+    node += [nodes.inline('x', 'x', classes=['n']), nodes.Text(' = 1')]
+
+    assert node.tagname == seac._GALLERY_CODE_BLOCK_TAGNAME
+    assert node['lang'] == 'Python'  # not 'language', as a literal_block spells it
+    assert node.astext() == 'x = 1'  # children concatenate, with nothing between
+
+
+def test_convert_literal_block_gallery_code_block():
+    # The source arrives as a stream of per-token nodes of three different
+    # kinds -- bare text, a classified inline, and a reference around a name
+    # that resolved -- so it has to be stitched back together rather than
+    # just read off the node.
+    node = _gallery_code_block(
+        _token('x', 'n'),
+        _token(' = '),
+        _token('1', 'mi'),
+        _token('\n', 'w'),
+        _token('print', 'nb'),
+        _token('(', 'p'),
+        _linked_token('x', 'n'),
+        _token(')', 'p'),
+        _token('\n', 'w'),
+    )
+    assert seac._convert_literal_block(node) == [('code', ['x = 1', 'print(x)'])]
+
+
+def test_convert_literal_block_gallery_code_block_reads_lang_not_language():
+    # Read from 'language' (which this node type doesn't set) the language
+    # comes back empty, and real code quietly degrades into comments.
+    node = _gallery_code_block(_token('x = 1'))
+    assert 'language' not in node
+    assert seac._convert_literal_block(node) == [('code', ['x = 1'])]
+
+
+def test_convert_literal_block_gallery_code_block_drops_line_numbers():
+    # With line numbers on, sphinx-gallery interleaves them as inline nodes
+    # of their own -- page furniture that was never part of the source, so
+    # it must not be baked into the generated script.
+    node = _gallery_code_block(
+        _token(' 9', 'linenos'),
+        _token('x', 'n'),
+        _token(' = 1\n'),
+        _token('10', 'linenos'),
+        _token('y', 'n'),
+        _token(' = 2\n'),
+    )
+    assert seac._convert_literal_block(node) == [('code', ['x = 1', 'y = 2'])]
+
+
 # ---------------------------------------------------------------------------
 # _clean_stray_rst_markup / _clean_code_comment
 # ---------------------------------------------------------------------------
@@ -669,6 +758,136 @@ def test_list_segment_ipynb_link_item_renders_as_markdown_link():
     ]
 
 
+# ---------------------------------------------------------------------------
+# _table_segment
+# ---------------------------------------------------------------------------
+
+_SIMPLE_TABLE = """
+.. list-table::
+   :header-rows: 1
+
+   * - Style
+     - Description
+   * - ``"-"``
+     - Solid
+"""
+
+_IMAGE_COLUMN_TABLE = """
+.. list-table::
+   :header-rows: 1
+
+   * - Style
+     - Example
+   * - Solid
+     - .. image:: solid.png
+"""
+
+_BLANK_BODY_TABLE = """
+.. list-table::
+   :header-rows: 1
+
+   * - Style
+     - Example
+   * -
+     -
+"""
+
+_SPANNING_TABLE = """
++------+------+
+| a    | b    |
++------+------+
+| spans both  |
++------+------+
+"""
+
+
+def test_table_segment_py_is_an_rst_simple_table():
+    doctree = _parse(_SIMPLE_TABLE)
+    assert seac._convert_node(doctree[0], _ctx()) == [
+        (
+            'directive',
+            [
+                '# =====  ===========',
+                '# Style  Description',
+                '# =====  ===========',
+                '# `"-"`  Solid',
+                '# =====  ===========',
+            ],
+        )
+    ]
+
+
+def test_table_segment_ipynb_is_a_markdown_table():
+    doctree = _parse(_SIMPLE_TABLE)
+    assert seac._convert_node(doctree[0], _ctx(fmt='ipynb')) == [
+        (
+            'directive',
+            [
+                '# | Style | Description |',
+                '# | ----- | ----------- |',
+                '# | `"-"` | Solid       |',
+            ],
+        )
+    ]
+
+
+def test_table_segment_caption_sits_above_the_table():
+    doctree = _parse('.. list-table:: Line styles\n\n   * - one\n')
+    kind, lines = seac._convert_node(doctree[0], _ctx())[0]
+    assert kind == 'directive'
+    assert lines[:2] == ['# Line styles', '#']
+
+
+def test_table_segment_header_less_table_has_no_inner_border():
+    doctree = _parse('.. list-table::\n\n   * - a\n     - b\n   * - c\n     - d\n')
+    assert seac._convert_node(doctree[0], _ctx()) == [
+        ('directive', ['# =  =', '# a  b', '# c  d', '# =  ='])
+    ]
+
+
+def test_table_segment_header_less_table_gets_a_blank_markdown_header():
+    doctree = _parse('.. list-table::\n\n   * - a\n     - b\n')
+    assert seac._convert_node(doctree[0], _ctx(fmt='ipynb')) == [
+        ('directive', ['# |     |     |', '# | --- | --- |', '# | a   | b   |'])
+    ]
+
+
+def test_table_segment_image_only_column_is_dropped():
+    doctree = _parse(_IMAGE_COLUMN_TABLE)
+    _kind, lines = seac._convert_node(doctree[0], _ctx())[0]
+    assert lines == ['# =====', '# Style', '# =====', '# Solid', '# =====']
+
+
+def test_table_segment_blank_body_row_is_dropped_with_every_column_kept():
+    doctree = _parse(_BLANK_BODY_TABLE)
+    _kind, lines = seac._convert_node(doctree[0], _ctx())[0]
+    assert lines == ['# =====  =======', '# Style  Example', '# =====  =======']
+
+
+def test_table_segment_column_span_pads_with_empty_cells():
+    doctree = _parse(_SPANNING_TABLE)
+    _kind, lines = seac._convert_node(doctree[0], _ctx())[0]
+    assert lines == ['# ==========  =', '# a           b', '# spans both', '# ==========  =']
+
+
+def test_table_segment_markdown_escapes_a_pipe_in_a_cell():
+    doctree = _parse('.. list-table::\n\n   * - ``a | b``\n')
+    assert seac._convert_node(doctree[0], _ctx(fmt='ipynb')) == [
+        ('directive', ['# |          |', '# | -------- |', r'# | `a \| b` |'])
+    ]
+
+
+def test_table_segment_list_in_a_cell_separates_items():
+    doctree = _parse('.. list-table::\n\n   * - - first\n       - second\n')
+    assert seac._convert_node(doctree[0], _ctx()) == [
+        ('directive', ['# =============', '# first; second', '# ============='])
+    ]
+
+
+def test_table_segment_empty_table_returns_nothing():
+    assert seac._convert_node(nodes.table(), _ctx()) == []
+
+
 # ---------------------------------------------------------------------------
 # _convert_admonition / _convert_node dispatch
 # ---------------------------------------------------------------------------
@@ -802,6 +1021,24 @@ def test_convert_node_literal_block_dispatch():
     assert seac._convert_node(node, _ctx()) == [('code', ['x = 1'])]
 
 
+def test_convert_node_gallery_code_block_dispatch():
+    # Unrecognized, this node falls through to the prose branch and the whole
+    # example turns into comments -- leaving nothing the extension counts as
+    # real code, and so no download link at all.
+    node = _gallery_code_block(_token('x', 'n'), _token(' = '), _token('1', 'mi'))
+
+    assert seac._convert_node(node, _ctx()) == [('code', ['x = 1'])]
+
+
+def test_convert_node_gallery_code_block_script_out_still_skipped():
+    # sphinx-gallery copies the original block's classes onto the node it
+    # swaps in, so captured output it happened to rewrite stays excluded.
+    node = _gallery_code_block(_token('3'))
+    node['classes'] = ['sphx-glr-script-out']
+
+    assert seac._convert_node(node, _ctx()) == []
+
+
 # ---------------------------------------------------------------------------
 # _has_real_code
 # ---------------------------------------------------------------------------

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/tests/test_tinypages.py

@@ -211,6 +211,56 @@ def test_docstring_examples_conversion(built: tuple[Path, list[Path]]):
     assert '3' not in combined_src  # doctest output line dropped entirely, not commented
 
 
+def test_table_becomes_an_rst_simple_table_in_py(built: tuple[Path, list[Path]]):
+    """A table converts to an aligned RST simple table, captioned above it."""
+    lines = _read(built[1], 'case_table.py').splitlines()
+    start = lines.index('# Line styles')
+    assert lines[start + 1] == '#'
+    assert lines[start + 2] == '# ======  ==========='
+    assert lines[start + 3] == '# Style   Description'
+    assert lines[start + 4] == '# ======  ==========='
+    assert lines[start + 5] == '# `"-"`   Solid'
+    assert lines[start + 6] == '# `"--"`  Dashed'
+    assert lines[start + 7] == '# ======  ==========='
+    # the "Example" column holds nothing in any row, so it is dropped
+    assert 'Example' not in '\n'.join(lines[start : start + 8])
+
+
+def test_table_becomes_a_markdown_table_in_ipynb(built_notebooks: list[Path]):
+    """The same table is a Markdown pipe table in a notebook's markdown cell."""
+    nb_path = next(p for p in built_notebooks if p.stem == 'docstring_cases_case_table')
+    notebook = json.loads(nb_path.read_text(encoding='utf-8'))
+    lines = [
+        line.rstrip()
+        for cell in notebook['cells']
+        if cell['cell_type'] == 'markdown'
+        for line in cell['source']
+    ]
+    start = lines.index('Line styles')
+    assert lines[start + 1] == ''
+    assert lines[start + 2] == '| Style  | Description |'
+    assert lines[start + 3] == '| ------ | ----------- |'
+    assert lines[start + 4] == '| `"-"`  | Solid       |'
+    assert lines[start + 5] == '| `"--"` | Dashed      |'
+
+
+def test_header_less_table_gets_a_blank_markdown_header(built_notebooks: list[Path]):
+    """A Markdown pipe table needs a header row, so one is left blank."""
+    nb_path = next(
+        p for p in built_notebooks if p.stem == 'docstring_cases_case_table_without_header'
+    )
+    notebook = json.loads(nb_path.read_text(encoding='utf-8'))
+    lines = [
+        line.rstrip()
+        for cell in notebook['cells']
+        if cell['cell_type'] == 'markdown'
+        for line in cell['source']
+    ]
+    assert '|      |       |' in lines
+    assert '| ---- | ----- |' in lines
+    assert '| left | right |' in lines
+
+
 def test_no_doctest_output_included(built: tuple[Path, list[Path]]):
     """Doctest output lines should never appear anywhere -- only the input code."""
     src = _read(built[1], 'case_doctest_with_output')

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/docstring_cases.py

@@ -45,6 +45,44 @@ def case_tabset():
     """
 
 
+def case_table():
+    """Docstring with a table in its Examples section.
+
+    Examples
+    --------
+    >>> import sys
+
+    .. list-table:: Line styles
+       :header-rows: 1
+
+       * - Style
+         - Description
+         - Example
+       * - ``"-"``
+         - Solid
+         -
+       * - ``"--"``
+         - Dashed
+         -
+
+    """
+
+
+def case_table_without_header():
+    """Docstring with a header-less table in its Examples section.
+
+    Examples
+    --------
+    >>> import sys
+
+    .. list-table::
+
+       * - left
+         - right
+
+    """
+
+
 def case_note():
     """Docstring with a note in its Examples section.
 

{sphinx_examples_as_code-0.5.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/docstring_cases.rst

@@ -13,6 +13,10 @@ resolve to.
 
 .. autofunction:: docstring_cases.case_tabset
 
+.. autofunction:: docstring_cases.case_table
+
+.. autofunction:: docstring_cases.case_table_without_header
+
 .. autofunction:: docstring_cases.case_note
 
 .. autofunction:: docstring_cases.case_warning

sphinx_examples_as_code-0.5.0/sphinx_examples_as_code.egg-info/requires.txt

@@ -1 +0,0 @@
-pyvista>=0.48

sphinx_examples_as_code-0.5.0/sphinx_examples_as_code.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.5.0",
-  "distance": 0,
-  "node": "g7bd70a33e84d064efda810292fbddfbbe32209bb",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-08-20"
-}

sphinx_examples_as_code-0.5.0/tests/gallery_fixture/index.rst

@@ -1,7 +0,0 @@
-Gallery Downloads Fixture
-=========================
-
-.. toctree::
-    :maxdepth: 2
-
-    auto_examples/index