nbsync 0.1.1__tar.gz → 0.1.3__tar.gz

{nbsync-0.1.1 → nbsync-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbsync
-Version: 0.1.1
+Version: 0.1.3
 Summary: MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization
 Project-URL: Documentation, https://daizutabi.github.io/nbsync/
 Project-URL: Source, https://github.com/daizutabi/nbsync
@@ -134,14 +134,6 @@ Use standard Markdown image syntax with the figure identifier:
 ![Chart description](my-notebook.ipynb){#my-figure}
 ```
 
-## Advanced Usage
-
-For more detailed information on how to use nbsync, see:
-
-- [Notebook Configuration](usage/notebook.md) - Setting up notebook directories
-- [Class Options](usage/class.md) - Control how notebook content is displayed
-<!-- - [Workflow Tips](usage/workflow.md) - Best practices for documentation -->
-
 ## The Power of Separation
 
 Creating documentation and developing visualizations involve different

{nbsync-0.1.1 → nbsync-0.1.3}/README.md

@@ -89,14 +89,6 @@ Use standard Markdown image syntax with the figure identifier:
 ![Chart description](my-notebook.ipynb){#my-figure}
 ```
 
-## Advanced Usage
-
-For more detailed information on how to use nbsync, see:
-
-- [Notebook Configuration](usage/notebook.md) - Setting up notebook directories
-- [Class Options](usage/class.md) - Control how notebook content is displayed
-<!-- - [Workflow Tips](usage/workflow.md) - Best practices for documentation -->
-
 ## The Power of Separation
 
 Creating documentation and developing visualizations involve different

{nbsync-0.1.1 → nbsync-0.1.3}/docs/getting-started/first-steps.md

@@ -159,7 +159,7 @@ plt.title('Scatter Plot by Group')
 
 ![Scatter plot](){#scatter}
 
-## 6. Run Your Documentation
+### 7. Run Your Documentation
 
 Start the MkDocs development server:
 
@@ -167,14 +167,6 @@ Start the MkDocs development server:
 mkdocs serve --open
 ```
 
-## Next Steps
-
-Now that you have the basics working, you can:
-
-1. [Explore advanced notebook features](../usage/notebook.md)
-2. [Learn about Python file integration](../usage/python-files.md)
-3. [Discover markdown-based notebooks](../usage/markdown-files.md)
-
 ## Troubleshooting
 
 ### Common Issues

{nbsync-0.1.1 → nbsync-0.1.3}/docs/index.md

@@ -104,6 +104,25 @@ layouts.
 | ![](){`plot(np.sin)`} | ![](){`plot(np.cos)`} |
 ```
 
+### Code Execution with markdown-exec Style Syntax
+
+nbsync supports the markdown-exec style code blocks with the `exec="1"`
+attribute as a compatible approach to code execution. While this syntax
+is familiar to markdown-exec users, nbsync executes it through the
+Jupyter Notebook engine instead, providing the ability to render diverse
+MIME content types (HTML, SVG, images, etc.) directly in your
+documentation. This enables richer and more complex outputs than
+traditional execution methods.
+
+````markdown source="tabbed-nbsync"
+```python exec="1" source="tabbed-left"
+import numpy as np
+from PIL import Image
+x = np.random.randint(0, 255, (100, 100), dtype=np.uint8)
+Image.fromarray(x)
+```
+````
+
 ### Dynamic Updates and Execution
 
 Automatic synchronization between notebooks and documentation ensures code

{nbsync-0.1.1 → nbsync-0.1.3}/mkdocs.yaml

@@ -58,9 +58,6 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.tabbed:
       alternate_style: true
-  - tables
-  - toc:
-      permalink: true
 nav:
   - Home: index.md
   - Getting Started:

{nbsync-0.1.1 → nbsync-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nbsync"
-version = "0.1.1"
+version = "0.1.3"
 description = "MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization"
 readme = "README.md"
 license = { file = "LICENSE" }

{nbsync-0.1.1 → nbsync-0.1.3}/src/nbsync/markdown.py

@@ -12,6 +12,49 @@ if TYPE_CHECKING:
 Element: TypeAlias = str | CodeBlock | Image
 
 
+def convert_code_block(code_block: CodeBlock) -> Iterator[Element]:
+    for elem in _convert_code_block_tabbed(code_block):
+        if isinstance(elem, CodeBlock):
+            yield _convert_code_block_exec(elem)
+        else:
+            yield elem
+
+
+def _convert_code_block_tabbed(code_block: CodeBlock) -> Iterator[Element]:
+    source = code_block.attributes.get("source", None)
+    if source != "tabbed-nbsync":
+        yield code_block
+        return
+
+    markdown = code_block.text.replace('source="tabbed-nbsync"', "")
+    markdown = textwrap.indent(markdown, "    ")
+    yield f'===! "Markdown"\n\n{markdown}\n\n'
+
+    text = textwrap.indent(code_block.source, "    ")
+    text = f'=== "Rendered"\n\n{text}'
+    yield from nbstore.markdown.parse(text)
+
+
+def _convert_code_block_exec(code_block: CodeBlock) -> CodeBlock | Image:
+    exec_ = code_block.attributes.get("exec", None)
+    if exec_ != "1" or not code_block.classes:
+        return code_block
+
+    if code_block.classes[0] != "python":
+        return code_block
+
+    del code_block.attributes["exec"]
+    return Image(
+        code_block.indent,
+        "",
+        code_block.classes[1:],
+        code_block.attributes,
+        code_block.source,
+        url=".md",
+        indent=code_block.indent,
+    )
+
+
 def convert_image(image: Image, index: int | None = None) -> Iterator[Element]:
     if image.source:
         if not image.identifier and index is None:
@@ -29,24 +72,6 @@ def convert_image(image: Image, index: int | None = None) -> Iterator[Element]:
         yield image.text
 
 
-def convert_code_block(code_block: CodeBlock) -> Iterator[Element]:
-    source = code_block.attributes.get("source", None)
-    if source == "tabbed-nbsync":
-        yield from _convert_code_block_tabbed(code_block)
-    else:
-        yield code_block
-
-
-def _convert_code_block_tabbed(code_block: CodeBlock) -> Iterator[Element]:
-    markdown = code_block.text.replace('source="tabbed-nbsync"', "")
-    markdown = textwrap.indent(markdown, "    ")
-    yield f'===! "Markdown"\n\n{markdown}\n\n'
-
-    text = textwrap.indent(code_block.source, "    ")
-    text = f'=== "Rendered"\n\n{text}'
-    yield from nbstore.markdown.parse(text)
-
-
 SUPPORTED_EXTENSIONS = (".ipynb", ".md", ".py")
 
 

{nbsync-0.1.1 → nbsync-0.1.3}/src/nbsync/sync.py

@@ -62,8 +62,8 @@ class Synchronizer:
                 if isinstance(elem, Image):
                     nb = self.notebooks[elem.url].nb
                     yield convert_image(elem, nb)
-                else:
-                    yield convert_code_block(elem)
+                elif code_block := convert_code_block(elem):
+                    yield code_block
 
 
 def update_notebooks(

{nbsync-0.1.1 → nbsync-0.1.3}/tests/test_cell.py

@@ -101,3 +101,8 @@ def test_tabbed_right_title(convert):
 def test_unknown(convert):
     x = convert("![a](a.ipynb){#id source='unknown' tabs='a|b'}")
     assert x == "2"
+
+
+def test_code_block_exec(convert):
+    x = convert('```python exec="1" source="1"\nprint(1+1)\n```')
+    assert x == "```python\nprint(1+1)\n```\n\n2"

{nbsync-0.1.1 → nbsync-0.1.3}/tests/test_markdown.py

@@ -123,6 +123,41 @@ def test_convert_tabbed_code_block_image():
     assert elems[2].text.startswith("    ![")
 
 
+def test_convert_code_block_exec_1():
+    from nbsync.markdown import convert_code_block
+
+    text = '```python exec="1" a\nprint(1+1)\n```'
+    elems = nbstore.markdown.parse(text)
+    code_block = list(elems)[0]
+    assert isinstance(code_block, CodeBlock)
+    x = next(convert_code_block(code_block))
+    assert isinstance(x, Image)
+    assert x.classes == ["a"]
+    assert x.url == ".md"
+
+
+def test_convert_code_block_exec_on():
+    from nbsync.markdown import convert_code_block
+
+    text = '```python exec="on" a\nprint(1+1)\n```'
+    elems = nbstore.markdown.parse(text)
+    code_block = list(elems)[0]
+    assert isinstance(code_block, CodeBlock)
+    x = next(convert_code_block(code_block))
+    assert isinstance(x, CodeBlock)
+
+
+def test_convert_code_block_exec_not_python():
+    from nbsync.markdown import convert_code_block
+
+    text = '```bash exec="1" a\nls\n```'
+    elems = nbstore.markdown.parse(text)
+    code_block = list(elems)[0]
+    assert isinstance(code_block, CodeBlock)
+    x = next(convert_code_block(code_block))
+    assert isinstance(x, CodeBlock)
+
+
 def test_set_url():
     from nbsync.markdown import set_url