nbsync 0.1.4__tar.gz → 0.2.0__tar.gz

{nbsync-0.1.4 → nbsync-0.2.0}/.github/workflows/docs.yaml

@@ -24,6 +24,6 @@ jobs:
       - name: Install uv
         run: pip install uv
       - name: Install the project
-        run: uv sync
+        run: uv sync --group docs
       - name: Deploy documentation
         run: uv run mkdocs gh-deploy --force

{nbsync-0.1.4 → nbsync-0.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: nbsync
-Version: 0.1.4
-Summary: MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization
+Version: 0.2.0
+Summary: A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution
 Project-URL: Documentation, https://daizutabi.github.io/nbsync/
 Project-URL: Source, https://github.com/daizutabi/nbsync
 Project-URL: Issues, https://github.com/daizutabi/nbsync/issues
@@ -28,7 +28,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
-Keywords: documentation,dynamic-execution,jupyter,markdown,mkdocs,notebook,python,real-time-sync,visualization
+Keywords: documentation,dynamic-execution,jupyter,markdown,notebook,python,real-time-sync,visualization
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
@@ -39,8 +39,7 @@ Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing :: Markup :: Markdown
 Requires-Python: >=3.10
-Requires-Dist: mkdocs>=1.6
-Requires-Dist: nbstore>=0.4.7
+Requires-Dist: nbstore>=0.4.11
 Description-Content-Type: text/markdown
 
 # nbsync
@@ -50,11 +49,9 @@ Description-Content-Type: text/markdown
 [![Build Status][GHAction-image]][GHAction-link]
 [![Coverage Status][codecov-image]][codecov-link]
 
-<strong>Connect Jupyter notebooks to your MkDocs documentation</strong>
+<strong>Connect Jupyter notebooks and Markdown documents</strong>
 
-nbsync is a MkDocs plugin that seamlessly embeds Jupyter notebook
-visualizations in your documentation, solving the disconnect between
-code development and documentation.
+nbsync is a core library that seamlessly bridges Jupyter notebooks and Markdown documents, enabling dynamic content synchronization and execution.
 
 ## Why Use nbsync?
 
@@ -68,7 +65,7 @@ Data scientists, researchers, and technical writers face a common dilemma:
 
 ### Our Solution
 
-This plugin creates a live bridge between your notebooks and documentation by:
+nbsync creates a live bridge between your notebooks and markdown documents by:
 
 - **Keeping environments separate** - work in the tool best suited for each task
 - **Maintaining connections** - reference specific figures from notebooks
@@ -86,7 +83,7 @@ This plugin creates a live bridge between your notebooks and documentation by:
 
 - **Automatic Updates**:
   When you modify your notebooks, your documentation updates
-  automatically in MkDocs serve mode.
+  automatically.
 
 - **Clean Source Documents**:
   Your markdown remains readable and focused on content, without
@@ -104,14 +101,27 @@ This plugin creates a live bridge between your notebooks and documentation by:
 pip install nbsync
 ```
 
-### 2. Configuration
+### 2. Basic Usage
 
-Add to your `mkdocs.yml`:
+```python
+from nbsync.sync import Synchronizer
+from nbstore import Store
+
+# Initialize with a notebook store
+store = Store("path/to/notebooks")
+sync = Synchronizer(store)
+
+# Process markdown with notebook references
+markdown_text = """
+# My Document
+
+![Chart description](my-notebook.ipynb){#my-figure}
+"""
 
-```yaml
-plugins:
-  - nbsync:
-      src_dir: ../notebooks
+# Convert markdown with notebook references to final output
+for element in sync.convert(markdown_text):
+    # Process each element (string or Cell objects)
+    print(element)
 ```
 
 ### 3. Mark Figures in Your Notebook
@@ -140,14 +150,14 @@ Creating documentation and developing visualizations involve different
 workflows and timeframes. When building visualizations in Jupyter notebooks,
 you need rapid cycles of execution, verification, and modification.
 
-This plugin is designed specifically to address these separation of
+nbsync is designed specifically to address these separation of
 concerns, allowing you to:
 
 - **Focus on code** in notebooks without documentation distractions
 - **Focus on narrative** in markdown without code interruptions
 - **Maintain powerful connections** between both environments
 
-Each environment is optimized for its purpose, while the plugin
+Each environment is optimized for its purpose, while nbsync
 handles the integration automatically.
 
 ## Contributing

{nbsync-0.1.4 → nbsync-0.2.0}/README.md

@@ -5,11 +5,9 @@
 [![Build Status][GHAction-image]][GHAction-link]
 [![Coverage Status][codecov-image]][codecov-link]
 
-<strong>Connect Jupyter notebooks to your MkDocs documentation</strong>
+<strong>Connect Jupyter notebooks and Markdown documents</strong>
 
-nbsync is a MkDocs plugin that seamlessly embeds Jupyter notebook
-visualizations in your documentation, solving the disconnect between
-code development and documentation.
+nbsync is a core library that seamlessly bridges Jupyter notebooks and Markdown documents, enabling dynamic content synchronization and execution.
 
 ## Why Use nbsync?
 
@@ -23,7 +21,7 @@ Data scientists, researchers, and technical writers face a common dilemma:
 
 ### Our Solution
 
-This plugin creates a live bridge between your notebooks and documentation by:
+nbsync creates a live bridge between your notebooks and markdown documents by:
 
 - **Keeping environments separate** - work in the tool best suited for each task
 - **Maintaining connections** - reference specific figures from notebooks
@@ -41,7 +39,7 @@ This plugin creates a live bridge between your notebooks and documentation by:
 
 - **Automatic Updates**:
   When you modify your notebooks, your documentation updates
-  automatically in MkDocs serve mode.
+  automatically.
 
 - **Clean Source Documents**:
   Your markdown remains readable and focused on content, without
@@ -59,14 +57,27 @@ This plugin creates a live bridge between your notebooks and documentation by:
 pip install nbsync
 ```
 
-### 2. Configuration
+### 2. Basic Usage
 
-Add to your `mkdocs.yml`:
+```python
+from nbsync.sync import Synchronizer
+from nbstore import Store
+
+# Initialize with a notebook store
+store = Store("path/to/notebooks")
+sync = Synchronizer(store)
+
+# Process markdown with notebook references
+markdown_text = """
+# My Document
+
+![Chart description](my-notebook.ipynb){#my-figure}
+"""
 
-```yaml
-plugins:
-  - nbsync:
-      src_dir: ../notebooks
+# Convert markdown with notebook references to final output
+for element in sync.convert(markdown_text):
+    # Process each element (string or Cell objects)
+    print(element)
 ```
 
 ### 3. Mark Figures in Your Notebook
@@ -95,14 +106,14 @@ Creating documentation and developing visualizations involve different
 workflows and timeframes. When building visualizations in Jupyter notebooks,
 you need rapid cycles of execution, verification, and modification.
 
-This plugin is designed specifically to address these separation of
+nbsync is designed specifically to address these separation of
 concerns, allowing you to:
 
 - **Focus on code** in notebooks without documentation distractions
 - **Focus on narrative** in markdown without code interruptions
 - **Maintain powerful connections** between both environments
 
-Each environment is optimized for its purpose, while the plugin
+Each environment is optimized for its purpose, while nbsync
 handles the integration automatically.
 
 ## Contributing

nbsync-0.2.0/docs/index.md

@@ -0,0 +1 @@
+# nbsync

{nbsync-0.1.4 → nbsync-0.2.0}/mkdocs.yaml

@@ -41,10 +41,8 @@ theme:
     - search.suggest
 plugins:
   - search
-  - nbsync:
-      src_dir:
-        - ../notebooks
-        - ../scripts
+  - mkapi:
+      debug: true
 markdown_extensions:
   - admonition
   - pymdownx.emoji:
@@ -60,7 +58,4 @@ markdown_extensions:
       alternate_style: true
 nav:
   - Home: index.md
-  - Getting Started:
-      - getting-started/installation.md
-      - getting-started/configuration.md
-      - getting-started/first-steps.md
+  - API: $api/nbsync.***

{nbsync-0.1.4 → nbsync-0.2.0}/pyproject.toml

@@ -4,15 +4,14 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nbsync"
-version = "0.1.4"
-description = "MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization"
+version = "0.2.0"
+description = "A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
 keywords = [
   "jupyter",
   "notebook",
-  "mkdocs",
   "documentation",
   "markdown",
   "python",
@@ -32,31 +31,23 @@ classifiers = [
   "Topic :: Text Processing :: Markup :: Markdown",
 ]
 requires-python = ">=3.10"
-dependencies = ["mkdocs>=1.6", "nbstore>=0.4.7"]
+dependencies = ["nbstore>=0.4.11"]
 
 [project.urls]
 Documentation = "https://daizutabi.github.io/nbsync/"
 Source = "https://github.com/daizutabi/nbsync"
 Issues = "https://github.com/daizutabi/nbsync/issues"
 
-[project.entry-points."mkdocs.plugins"]
-nbsync = "nbsync.plugin:Plugin"
-
 [dependency-groups]
 dev = [
   "ipykernel>=6.29.5",
   "matplotlib>=3.10.1",
-  "mkdocs-material>=9.6.11",
   "nbconvert>=7.16.6",
-  "pandas>=2.2",
-  "polars>=1.26",
-  "pytest-clarity>=1.0.1",
   "pytest-cov>=6.1.0",
   "pytest-randomly>=3.16.0",
-  "pytest-xdist>=3.6.1",
   "ruff>=0.11.4",
-  "seaborn>=0.13.2",
 ]
+docs = ["mkapi", "mkdocs-material"]
 
 [tool.pytest.ini_options]
 testpaths = ["src", "tests"]
@@ -81,11 +72,4 @@ unfixable = ["F401"]
 ignore = ["ANN401", "ARG001", "ARG002", "C901", "D", "PLR0911", "S105"]
 
 [tool.ruff.lint.per-file-ignores]
-"**/tests/*" = ["ANN", "ARG", "D", "FBT", "PLR", "RUF", "S", "PGH003"]
-"**/{notebooks,scripts}/*" = ["ANN", "ERA001", "NPY", "T201"]
-
-[tool.pyright]
-include = ["src", "tests"]
-strictDictionaryInference = true
-strictListInference = true
-strictSetInference = true
+"**/tests/*" = ["ANN", "ARG", "D", "FBT", "PGH003", "PLR", "RUF", "S", "SLF"]

{nbsync-0.1.4 → nbsync-0.2.0}/src/nbsync/cell.py

@@ -5,10 +5,9 @@ import uuid
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
+from nbsync import logger
 from nbsync.markdown import is_truelike
 
-from .logger import logger
-
 if TYPE_CHECKING:
     from nbstore.markdown import Image
 

nbsync-0.2.0/src/nbsync/logger.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import logging
+from logging import Logger
+from typing import Any
+
+_logger = logging.getLogger("nbsync")
+
+
+def configure(logger: Logger | None = None) -> Logger:
+    global _logger  # noqa: PLW0603
+
+    if logger:
+        _logger = logger
+
+    return _logger
+
+
+def debug(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.debug(msg, *args, **kwargs)
+
+
+def info(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.info(msg, *args, **kwargs)
+
+
+def warning(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.warning(msg, *args, **kwargs)
+
+
+def error(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.error(msg, *args, **kwargs)

{nbsync-0.1.4 → nbsync-0.2.0}/src/nbsync/sync.py

@@ -10,12 +10,11 @@ from nbstore.markdown import CodeBlock, Image
 from nbstore.notebook import get_language, get_mime_content, get_source
 
 import nbsync.markdown
+from nbsync import logger
 from nbsync.cell import Cell
 from nbsync.markdown import is_truelike
 from nbsync.notebook import Notebook
 
-from .logger import logger
-
 if TYPE_CHECKING:
     from collections.abc import Iterator
 

nbsync-0.2.0/tests/test_logger.py

@@ -0,0 +1,64 @@
+import logging
+from logging import Logger
+
+import pytest
+
+from nbsync import logger
+
+
+@pytest.fixture
+def reset_logger():
+    original_logger = logger._logger
+
+    yield
+
+    logger._logger = original_logger
+
+
+def test_default_logger():
+    assert isinstance(logger._logger, Logger)
+    assert logger._logger.name == "nbsync"
+
+
+def test_configure(reset_logger):
+    custom_logger = logging.getLogger("custom_logger")
+
+    result = logger.configure(custom_logger)
+
+    assert result is custom_logger
+    assert logger._logger is custom_logger
+    assert logger._logger.name == "custom_logger"
+
+
+def test_configure_no_args(reset_logger):
+    custom_logger = logging.getLogger("custom_logger")
+    logger._logger = custom_logger
+
+    result = logger.configure()
+
+    assert result is custom_logger
+    assert logger._logger is custom_logger
+
+
+def test_logging_methods(reset_logger, caplog):
+    caplog.set_level(logging.DEBUG, logger="nbsync")
+
+    debug_msg = "Debug message"
+    info_msg = "Info message"
+    warning_msg = "Warning message"
+    error_msg = "Error message"
+
+    logger.debug(debug_msg)
+    logger.info(info_msg)
+    logger.warning(warning_msg)
+    logger.error(error_msg)
+
+    assert debug_msg in caplog.text
+    assert info_msg in caplog.text
+    assert warning_msg in caplog.text
+    assert error_msg in caplog.text
+
+    assert (logger._logger.name, logging.DEBUG, debug_msg) in caplog.record_tuples
+    assert (logger._logger.name, logging.INFO, info_msg) in caplog.record_tuples
+    assert (logger._logger.name, logging.WARNING, warning_msg) in caplog.record_tuples
+    assert (logger._logger.name, logging.ERROR, error_msg) in caplog.record_tuples

{nbsync-0.1.4 → nbsync-0.2.0}/tests/test_sync.py

@@ -167,3 +167,10 @@ def test_sync_notebook_not_found():
 
     image = Image("abc", "id", [], {}, "", "a.ipynb")
     assert convert(image, {}) == ""
+
+
+def test_convert_no_id():
+    from nbsync.sync import convert
+
+    image = Image("abc", ".", [], {}, "", "a.ipynb")
+    assert convert(image, {}) == ""

nbsync-0.1.4/docs/getting-started/configuration.md

@@ -1,35 +0,0 @@
-# Configuration
-
-Configuring nbsync for your MkDocs site is simple but powerful, allowing you to
-customize how notebooks and Python files are integrated with your documentation.
-
-## Basic Configuration
-
-To use nbsync with MkDocs, add it to your `mkdocs.yml` file:
-
-```yaml
-plugins:
-  - search
-  - nbsync
-```
-
-This minimal configuration uses all the default settings.
-
-## Source Directory Configuration
-
-Specify where nbsync should look for notebooks and Python files:
-
-```yaml
-plugins:
-  - search
-  - nbsync:
-      src_dir:
-        - ../notebooks # Path to notebooks directory
-        - ../scripts # Path to Python scripts
-```
-
-The `src_dir` option can be:
-
-- A single path as a string
-- A list of paths
-- Relative to your docs directory

nbsync-0.1.4/docs/getting-started/first-steps.md

@@ -1,186 +0,0 @@
-# First Steps
-
-Let's walk through a quick example of using nbsync to integrate notebooks with
-your MkDocs documentation.
-
-## Setting Up Your Project
-
-Start with a typical MkDocs project structure:
-
-```
-my-project/
-├── docs/
-│   ├── index.md
-│   └── ...
-├── notebooks/
-│   ├── analysis.ipynb
-│   └── ...
-├── scripts/
-│   ├── plotting.py
-│   └── ...
-└── mkdocs.yml
-```
-
-## Configure MkDocs
-
-Update your `mkdocs.yml` to include nbsync:
-
-```yaml
-site_name: My Documentation
-theme:
-    name: material
-
-plugins:
-    - search
-    - nbsync:
-          src_dir:
-              - ../notebooks
-              - ../scripts
-```
-
-## Creating Your First Integration
-
-### 1. Prepare a Jupyter Notebook
-
-Create or use an existing notebook with visualizations.
-Tag cells you want to reference with a comment:
-
-![](analysis.ipynb){#simple-plot source="only" identifier="1" title="notebooks/analysis.ipynb"}
-
-### 2. Reference in Your Documentation
-
-In one of your markdown files (e.g., `docs/index.md`), add:
-
-```markdown
-# My Project Documentation
-
-Here's a visualization from our analysis:
-
-![Sine wave plot](analysis.ipynb){#simple-plot}
-```
-
-![Sine wave plot](analysis.ipynb){#simple-plot}
-
-### 3. Create a Python Script
-
-Create a file `scripts/plotting.py` with visualization functions:
-
-```python title="scripts/plotting.py"
---8<-- "scripts/plotting.py"
-```
-
-### 4. Use Functions in Your Documentation
-
-Create a new file `docs/examples.md`:
-
-```markdown
-# Examples
-
-Let's demonstrate different plots:
-
-![](plotting.py){#.}
-
-## Sine Waves
-
-|     Frequency = 1     |     Frequency = 2     |
-| :-------------------: | :-------------------: |
-| ![](){`plot_sine(1)`} | ![](){`plot_sine(2)`} |
-
-## Histogram Examples
-
-|           20 Bins           |           50 Bins           |
-| :-------------------------: | :-------------------------: |
-| ![](){`plot_histogram(20)`} | ![](){`plot_histogram(50)`} |
-```
-
-![](plotting.py){#.}
-
-|     Frequency = 1     |     Frequency = 2     |
-| :-------------------: | :-------------------: |
-| ![](){`plot_sine(1)`} | ![](){`plot_sine(2)`} |
-
-|           20 Bins           |           50 Bins           |
-| :-------------------------: | :-------------------------: |
-| ![](){`plot_histogram(20)`} | ![](){`plot_histogram(50)`} |
-
-### 5. Create a Markdown-Based Notebook
-
-Create a file `docs/custom.md`:
-
-````markdown
-# Custom Analysis
-
-Here's an analysis created directly in markdown:
-
-```python .md#_
-import numpy as np
-import pandas as pd
-
-# Generate sample data
-data = pd.DataFrame({
-    'x': np.random.randn(100),
-    'y': np.random.randn(100),
-    'group': np.random.choice(['A', 'B', 'C'], 100)
-})
-```
-
-```python .md#scatter
-import matplotlib.pyplot as plt
-import seaborn as sns
-
-plt.figure(figsize=(3, 2))
-sns.scatterplot(data=data, x='x', y='y', hue='group')
-plt.title('Scatter Plot by Group')
-```
-
-![Scatter plot](.md){#scatter}
-````
-
-```python .md#_
-import numpy as np
-import pandas as pd
-
-# Generate sample data
-data = pd.DataFrame({
-    'x': np.random.randn(100),
-    'y': np.random.randn(100),
-    'group': np.random.choice(['A', 'B', 'C'], 100)
-})
-```
-
-```python .md#scatter
-import matplotlib.pyplot as plt
-import seaborn as sns
-
-plt.figure(figsize=(3, 2))
-sns.scatterplot(data=data, x='x', y='y', hue='group')
-plt.title('Scatter Plot by Group')
-```
-
-![Scatter plot](){#scatter}
-
-### 7. Run Your Documentation
-
-Start the MkDocs development server:
-
-```bash
-mkdocs serve --open
-```
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Images Not Showing**:
-    - Check paths in your configuration
-    - Ensure notebooks have correctly tagged cells
-    - Verify Python dependencies are installed
-
-2. **Execution Errors**:
-    - Check the console output for error messages
-    - Ensure your environment has all required packages
-
-3. **Changes Not Reflecting**:
-    - Hard refresh your browser
-    - Restart the MkDocs server
-    - Check file paths and identifiers

nbsync-0.1.4/docs/getting-started/installation.md

@@ -1,35 +0,0 @@
-# Installation
-
-Installing nbsync is straightforward and can be done using uv or pip,
-the Python package manager.
-
-## Prerequisites
-
-Before installing nbsync, ensure you have the following:
-
-- Python 3.10 or higher
-- uv or pip (Python package manager)
-- MkDocs 1.6 or higher (documentation generator)
-
-## Basic Installation
-
-Install nbsync using uv or pip:
-
-```bash
-uv pip install nbsync
-# or
-pip install nbsync
-```
-
-This command installs the latest stable version of nbsync and its core
-dependencies.
-
-## Installation of nbconvert
-
-For dynamic execution functionality, install nbconvert:
-
-```bash
-uv pip install nbconvert
-# or
-pip install nbconvert
-```

nbsync-0.1.4/docs/index.md

@@ -1,138 +0,0 @@
-# nbsync
-
-<div class="grid cards" markdown>
-
-- :material-notebook-edit: **Notebooks from Markdown**
-  Extend standard markdown syntax to automatically generate notebooks from
-  documentation
-  [:octicons-arrow-right-24: Markdown Features](#notebooks-from-markdown)
-
-- :material-language-python: **Python File Integration**
-  Directly reference external Python files and reuse functions or classes
-  [:octicons-arrow-right-24: Python Integration](#python-file-integration)
-
-- :material-image-edit: **Code Execution in Images**
-  Execute code within image notation for dynamic visualizations
-  [:octicons-arrow-right-24: Dynamic Visualization](#code-execution-in-images)
-
-- :material-refresh-auto: **Dynamic Updates**
-  Real-time synchronization between notebooks and documentation
-  [:octicons-arrow-right-24: Dynamic Updates](#dynamic-updates-and-execution)
-
-</div>
-
-## What is nbsync?
-
-nbsync is an innovative MkDocs plugin that treats Jupyter notebooks,
-Python scripts, and Markdown files as first-class citizens for
-documentation. Unlike traditional approaches, nbsync provides equal
-capabilities across all file formats, enabling seamless integration
-and dynamic execution with real-time synchronization.
-
-It solves common challenges faced by data scientists, researchers, and technical
-writers:
-
-- **Development happens in notebooks** - ideal for experimentation and visualization
-- **Documentation lives in markdown** - perfect for narrative and explanation
-- **Code resides in Python files** - organized and version-controlled
-- **Traditional integration is challenging** - screenshots break, exports get outdated
-
-## Inspiration & Comparison
-
-nbsync was inspired by and builds upon the excellent work of two MkDocs
-plugins:
-
-- [**markdown-exec**](https://pawamoy.github.io/markdown-exec/) - Provides utilities to execute code blocks in Markdown files
-- [**mkdocs-jupyter**](https://mkdocs-jupyter.danielfrg.com/) - Enables embedding Jupyter notebooks in MkDocs
-
-While these plugins offer great functionality, nbsync takes a unified
-approach by:
-
-1. **Equal treatment** - Unlike other solutions that prioritize one format, nbsync treats Jupyter notebooks, Python scripts, and Markdown files equally as first-class citizens
-2. **Real-time synchronization** - Changes to source files are immediately reflected in documentation
-3. **Seamless integration** - Consistent syntax across all file formats allows for flexible documentation workflows
-4. **Image syntax code execution** - Unique ability to execute code and embed visualizations anywhere Markdown image syntax (`![alt](url)`) is valid, including tables, lists, and complex layouts
-
-## Acknowledgements
-
-The development of nbsync would not have been possible without the
-groundwork laid by markdown-exec and mkdocs-jupyter. We extend our
-sincere gratitude to the developers of these projects for their
-innovative contributions to the documentation ecosystem.
-
-## Key Features
-
-### Notebooks from Markdown
-
-Extend standard markdown syntax to define notebook cells within your
-documentation. Present code and its output results concisely with tabbed
-display.
-
-````markdown source="tabbed-nbsync"
-```python .md#plot
-import matplotlib.pyplot as plt
-
-fig, ax = plt.subplots(figsize=(2, 1))
-ax.plot([1, 3, 3, 4])
-```
-
-![Plot result](){#plot source="above"}
-````
-
-### Python File Integration
-
-Directly reference external Python files and reuse defined functions or
-classes. Avoid code duplication and improve maintainability.
-
-```python title="plot.py"
---8<-- "scripts/plot.py"
-```
-
-```markdown source="tabbed-nbsync"
-![Plot result](plot.py){#sqrt source="on"}
-```
-
-### Code Execution in Images
-
-Execute Python code directly within image notation and display the results.
-This enables easy placement of dynamic visualizations in tables or complex
-layouts.
-
-```markdown source="tabbed-nbsync"
-|         Sine          |        Cosine         |
-| :-------------------: | :-------------------: |
-| ![](){`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, (50, 200), dtype=np.uint8)
-Image.fromarray(x)
-```
-````
-
-### Dynamic Updates and Execution
-
-Automatic synchronization between notebooks and documentation ensures code
-changes are reflected in real-time. View changes instantly in MkDocs serve
-mode.
-
-## Getting Started
-
-Follow these steps to get started with nbsync:
-
-1. [Installation](getting-started/installation.md)
-2. [Configuration](getting-started/configuration.md)
-3. [First Steps](getting-started/first-steps.md)

nbsync-0.1.4/notebooks/analysis.ipynb

@@ -1,69 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Text(0.5, 1.0, 'Simple Sine Wave')"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    },
-    {
-     "data": {
-      "image/png": "iVBORw0KGgoAAAANSUhEUgAAAR8AAAC1CAYAAABmp/txAAAAOnRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjEwLjEsIGh0dHBzOi8vbWF0cGxvdGxpYi5vcmcvc2/+5QAAAAlwSFlzAAAPYQAAD2EBqD+naQAALAFJREFUeJztnXl4U8X6x78nSZN0S9rSfd8paymlLV0AxXorVmSRXaEsynIBRbw/Fb1SuV5ExatXuaiICgoqi7Ko7NYC0kJbWspaSoFuQHdo04UmbTK/P9JEQndIcrLM53nyPM05c86805PznZl3Zt5hCCEEFAqFomc4bBtAoVDMEyo+FAqFFaj4UCgUVqDiQ6FQWIGKD4VCYQUqPhQKhRWo+FAoFFag4kOhUFiBig+FQmEFKj4s4evri9mzZ7OS99tvvw2GYVjJm81yUwwLKj5a5vz585g0aRJ8fHwgFArh4eGBxx9/HOvWrWPbNJ1iyOXOzMwEwzD4+OOP250bN24cGIbBpk2b2p0bOXIkPDw89GGiWcLQtV3aIz09HY8++ii8vb2RlJQEV1dXlJaW4tSpU7h27RquXr2qTiuVSsHhcGBhYaF3O99++22sWrUK2nr0hl7u1tZWiMViPPHEE/j55581zjk5OaG2thZJSUn46quv1MdlMhnEYjHGjh2LHTt26M1Wc4LHtgGmxOrVqyEWi5GVlQU7OzuNc5WVlRrfBQKBHi3TLYZebh6Ph6ioKKSlpWkcz8/PR3V1NWbMmIETJ05onMvOzkZzczPi4uL0aapZQbtdWuTatWsYMGBAuxcQAJydnTW+3+/72Lx5MxiGwYkTJ/Diiy/CyckJdnZ2WLBgAWQyGWprazFr1izY29vD3t4er776qkbLpaioCAzD4MMPP8THH38MHx8fWFpaYtSoUbhw4UKP7N+6dSvCw8NhaWkJBwcHTJs2DaWlpXopd1paGpYvXw4nJydYW1tjwoQJqKqqane/AwcOYMSIEbC2toatrS0SExNx8eLFbm2Mi4tDRUWFRissLS0NIpEI8+fPVwvRvedU1wHA3r17kZiYCHd3dwgEAgQEBOCdd96BXC5XX7NkyRLY2NigqampXf7Tp0+Hq6urRvoHLYupQMVHi/j4+CA7O7vHL3tHLF26FAUFBVi1ahWefvppfPnll3jrrbcwduxYyOVyvPvuu4iLi8PatWuxZcuWdtd/9913+PTTT7F48WKsWLECFy5cwOjRo1FRUdFlvqtXr8asWbMQFBSEjz76CMuWLUNKSgpGjhyJ2tpavZT77NmzSE5OxqJFi/Drr79iyZIlGmm2bNmCxMRE2NjY4P3338dbb72FS5cuIS4uDkVFRV3eXyUi97Zw0tLSMHz4cERFRcHCwgLp6eka52xtbREaGgpAKZI2NjZYvnw5PvnkE4SHh2PlypV4/fXX1ddMnToVjY2N2Ldvn0beTU1N+PXXXzFp0iRwudyHLovJQCha4/Dhw4TL5RIul0uio6PJq6++Sg4dOkRkMlm7tD4+PiQpKUn9fdOmTQQASUhIIAqFQn08OjqaMAxDFi5cqD7W2tpKPD09yahRo9THCgsLCQBiaWlJbty4oT6ekZFBAJCXX35ZfSw5OZnc++iLiooIl8slq1ev1rDx/PnzhMfjtTuui3LHx8drlPvll18mXC6X1NbWEkIIqa+vJ3Z2duSFF17QuF95eTkRi8Xtjt+PRCIhXC6XzJs3T32sb9++ZNWqVYQQQiIjI8n//d//qc85OTmRxx9/XP29qamp3T0XLFhArKysSHNzMyGEEIVCQTw8PMgzzzyjkW7Hjh0EADl+/LhWymIq0JaPFnn88cdx8uRJPP300zh79iw++OADJCQkwMPDA7/88kuP7jFv3jyNYfCoqCgQQjBv3jz1MS6Xi2HDhuH69evtrh8/frzGCE1kZCSioqKwf//+TvPctWsXFAoFpkyZgurqavXH1dUVQUFBSE1N1Xm558+fr1HuESNGQC6Xo7i4GABw5MgR1NbWYvr06Ro2crlcREVFdWujra0tBg8erG75VFdXIz8/HzExMQCA2NhYdVfrypUrqKqq0vD3WFpaqv+ur69HdXU1RowYgaamJly+fBkAwDAMJk+ejP3796OhoUGdfvv27fDw8FDf72HLYipQ8dEyERER2LVrF+7cuYPMzEysWLEC9fX1mDRpEi5dutTt9d7e3hrfxWIxAMDLy6vd8Tt37rS7PigoqN2x4ODgLpvyBQUFIIQgKCgITk5OGp+8vLx2TuOO0Ha57e3tAUBdxoKCAgDA6NGj29l4+PDhHtkYFxen9u2kp6eDy+Vi+PDhAICYmBhkZ2dDKpW28/cAwMWLFzFhwgSIxWKIRCI4OTnhueeeAwDU1dWp002dOhV3795Vi25DQwP279+PyZMnq8VVG2UxBehol47g8/mIiIhAREQEgoODMWfOHOzcuRPJycldXqfyCfTkONHSULlCoQDDMDhw4ECH+djY2PT4Xtout6qMCoUCgNJX4urq2i4dj9f9TzkuLg7r1q1DWloa0tPTMWjQIHXZYmJiIJVKkZWVhRMnToDH46mFqba2FqNGjYJIJMK//vUvBAQEQCgUIicnB6+99praNgAYPnw4fH19sWPHDsyYMQO//vor7t69i6lTp6rTaKMspoB5lJJlhg0bBgAoKyvTeV6qWvVerly5Al9f306vCQgIACEEfn5+CA4O1pot2ix3QEAAAOXoWXx8/APd416n88mTJxEbG6s+5+7uDh8fH6SlpSEtLQ1hYWGwsrICABw9ehQ1NTXYtWsXRo4cqb6msLCww3ymTJmCTz75BBKJBNu3b4evr69ayLRVFlOAdru0SGpqaoetEZW/pW/fvjq3Yc+ePbh586b6e2ZmJjIyMjBmzJhOr5k4cSK4XG6HEw8JIaipqekyT32UOyEhASKRCO+++y5aWlrane9oWP5+3N3d4efnh5SUFJw+fVrt71ERExODPXv2ID8/X6PLpWqV3VtGmUyGzz77rMN8pk6dCqlUim+//RYHDx7ElClTtF4WU4C2fLTI0qVL0dTUhAkTJiAkJAQymQzp6enq2m/OnDk6tyEwMBBxcXFYtGgRpFIp/vvf/6JPnz549dVXO70mICAA//73v7FixQoUFRVh/PjxsLW1RWFhIXbv3o358+fjH//4R6fX66PcIpEIn3/+OWbOnImhQ4di2rRpcHJyQklJCfbt24fY2Fj873//6/Y+cXFx6ikK97Z8AKX4/Pjjj+p09x63t7dHUlISXnzxRTAMgy1btnTa7R06dCgCAwPx5ptvQiqVanS5tFkWo4elUTaT5MCBA2Tu3LkkJCSE2NjYED6fTwIDA8nSpUtJRUWFRtrOhpyzsrI00qmGxauqqjSOJyUlEWtra/V31VD72rVryX/+8x/i5eVFBAIBGTFiBDl79myH97yfn3/+mcTFxRFra2tibW1NQkJCyOLFi0l+fr7ey52amkoAkNTU1HbHExISiFgsJkKhkAQEBJDZs2eT06dPd2mjig0bNhAAxMPDo925nJwcAoAAaGd3WloaGT58OLG0tCTu7u7q6QQd2UgIIW+++SYBQAIDAzu15WHLYuzQtV0mQlFREfz8/LB27douWykUiqFAfT4UCoUVqPhQKBRWoOJDoVBYgfp8KBQKK9CWD4VCYQUqPhQKhRUMepKhQqHArVu3YGtry1rAcwqF0jmEENTX18Pd3R0cTu/aMgYtPrdu3Wq3mptCoRgepaWl8PT07NU1OhWf48ePY+3atcjOzkZZWRl2796N8ePH9/h6W1tbAMqCiUQiHVlJoVAeFIlEAi8vL/W72ht0Kj6NjY0IDQ3F3LlzMXHixF5fr+pqiUQiKj4UigHzIG4RnYrPmDFjulxNTaGYA4QQ6rPsAIPy+UilUkilUvV3iUTCojXd09wix/7zZTh+pQoZhbdxp0kGhQJwshUgwtceo/o6IXGQO/g8OqhoLtQ0SHHwYjkOX6zApTIJJHdboCAEgc62GOguwoShHoj270PFCHqcZMgwTLc+H9VmdvdTV1dnUN2uVrkC27JKsT71KsrqmrtM62FniUWPBGB6pDe4HPqDM1WaZK348vh1bDh2HXdb5F2mDXG1xWtjQvBoX+cu0xkDEokEYrH4gd5RgxKfjlo+Xl5eBiU+5XXNWPpjDrKKlLGFXUVCTAr3RExgH3jZW4HDYVBY1YiMwhpsyypFVb2yPDEBffDx1CFwEQnZNJ+iA86W1uLv3+fgZu1dAEB/NxGeCnVDbIAj+tjwQQhwubwex65U4ufsm2pxmhbhhX8+1R82AoPqgPQKkxGf+3mYgumCjOs1WPR9Dm43ymAj4OGVvwVjeqQ3hBYdxx9ubpHjh4wSrD2Uj7stcjhY87FxVjjCfRz0bDlFV/yUfQNv7D4PWasCHnaWWPFkCBIHuXXaraprasEnKQX4Jk0ZgjXYxQbfzY2Cq9g4K6WHeUepM6KHpF2tRtKmTNxulKG/mwi/Lo3DnFi/ToUHAIQWXMyN88NvL8ZhgLsItxtlmPl1Jk5e6zosKcU4+PpEIf6x8yxkrQrE93PGgWUj8NRg9y79OWIrC6wc2x8/vjAczrYCXKlowDOfp+N6VUOn15gqOhWfhoYG5ObmIjc3F4Ay4HZubi5KSkp0ma3WOVFQjbmbs9DcosCjfZ2w6+8x8HO07vH1AU42+GlhDEYEOaJJJsfsTZlIv1bd/YUUg2XrqWK885tyS6CFowLw5cxhEAktenx9dEAf/LxI+Tu6WXsX0748pe62mQs6FZ/Tp08jLCwMYWFhAIDly5cjLCwMK1eu1GW2WuVKRT0Wbs2GtK12+2JmeJetnc6w5HOxcdYwPBbiDGmrAgu3ZJtlbWcK7DtXhn/uUW4NvXBUAF57oi84DzCY4OVghZ0LoxHsYoPKeinmbsqCpLl9QHlTRafi88gjj4AQ0u6zefNmXWarNe40yvD8t6fRIG1FpJ8DPns2HAJe74VHhdCCi/XPDsVQbztImlsx79vTqG2SadFiiq7JL6/H//10FgCQFO2D157o+1DD5o42AmyaEwlnWwHyK+rx9605kCvMI8oN9fl0gkJB8OK2Myi53QRPe0t88Vy4VubrCC242DBzGDzsLFFY3YiXt+dqbfM/im6pa2rB/C2n0SSTIy7QEW891V8r83U87CzxzewIWPG5OHG1Guv+aL/3milCxacTvj5RiD8LqmFpwcXXSRFwsOZr7d5OtgJ8lTQMAh4HqflV+Da9SGv3puiON/acR3GNsjJaNz0MPK72Xp+BHmKsnjAQAPBpSgFOXTf9QQkqPh2QVybB2kP5AICVY/ujr2vvF811Rz83Ed54sh8A4N0Dl5FfXq/1PCja45ezt7DvXBl4HAafPTsU9lqsjFRMCPPEpHBPKAiwbFsu6ppM2/9Dxec+ZK0KLNuWC5lcgfh+LpgWobuQHrOiffBoXyfIWhV4eXsuWuWK7i+i6J1KSTPeanMwLxkdiMGedjrLa9XTA+DvaI1ySTPWHMjTWT6GABWf+9j453XkV9SjjzUf7z0zSKdrcBiGwQeTQiG2tMClMgk20+6XQfLPPRdQd7cFgzzEWPxooE7zshbw8P6kwQCAbVmlJj0lg4rPPZTeblI7+95M7AdHG4HO83SyFWDFmBAAwH8OXzG7uR6GTmp+JQ5fqgCXw+DDyaGw0KKfpzMifB3wbJQ3AOCNXefR3M1aMWOFik8bhBAk/3IRzS0KDPd3wIQwD73lPWWYFyJ87XG3RY7kvRf1li+la5pb5Hj7F+XzmBvrqxPfX2e8NiYELiIBimqasPH4db3lq0+o+LRxNL8Kf1yuhAWXwb/H67a7dT8cDoN3JwwCj8Pg97wKpF013aa2MbHx+HUU1zTBRSTAS/HBes1bJLTAm4n9AQCfHb2GCknX0ROMESo+UIbIeHe/0rk3J9YPgc42erchyMUWzw33AQD8e1+e2Uw0M1QqJc34/Ng1AMAbT/ZjZeX52MFuGOpth7stcnxwMF/v+esaKj4AdmbfQEFlA+ysLHTuUOyKlx4LgkjIQ16ZBD9n32DNDgrw35QCNMnkGOJlh6dD3VmxgWEYrBw7AADwc84NnLtRy4odusLsxadR2or/HL4CAHhxdBDElj1fHKht7K35WDo6CADw4eF83JWZpqPR0LlW1YDtWaUAlK0eNqMODvGyw8Q2/6Nq7pmpYPbiszm9CNUNUvj0sVJ3e9hkVowPPO0tUVkvxZZTRWybY5Z8cPAy5AqC+H7OiPRjP/bSy48Hw4LL4M+CapMKx2LW4iNpbsGXbSMJyx8PNohYywIeFy8+pmz9fHHsOhqkrSxbZF5cuFmHQxcrwGGA154IYdscAMrV79MilEPvHx7ON5m1gOy/bSzyzYlC1N1tQZCzDZ4azE6/viMmhnnAz9EatxtldN2Xnvnv78p5XuOGeCDIRX9D692xZHQgBDwOsovvIDW/km1ztILZik9dUwu+/lMZynJZfLBBBXfncTl4qa31s+HYNbOK8cImF27W4fc8ZatnyWj2Bh46wkUkRFKMLwDgk5SrJtH6MVvx+SatEPXSVoS42mLMQFe2zWnH2FB3BDrbQNLcii0ni9k2xyy4t9UT4KT/6RbdMX+kP4QWHJwtrcUJE5gLZpbi0yBtVa+jWjI68IGi0OkaLofB4kcDACi7h3TkS7dcuiUx2FaPCkcbAaZHKn0/6/64yrI1D49Zis+PGSWou9sCf0drjBnoxrY5nTJ2sDs87S1R0yjD9izjinttbHzRNqEwcbC7QbZ6VMwf6Q8+l4PMwtvIMPKYP2YnPtJWOb46oRzhWjDK36B8PffD43KwcJSy9bPh+HXIWmnIDV1QUtOE387dAgAsGOnPsjVd4ya2xKRhngCUyy6MGbMTn105N1EhkcJNLMSEME+2zemWSeGecLYVoKyuGXtzb7Jtjkmy8c/rUBBgZLATBnqI2TanWxaM9AeHAY5dqcLlcsPeUrwrzEp8FAqCjX8qWz3z4vwMYl5PdwgtuJgT6wdAGdrVFEY5DInqBil2nFbOZl7U1so0dHz6WOOJtkGSjccLWbbmwTH8t0+LpOZX4npVI2yFPExrc9wZAzOivGHN5+JyeT3+LDD+UQ5DYuupYkhbFQj1ssNwf/ZnM/eUF0You4e/nL2J8jrjXPFuVuKjavXMiPQ2qv2xxZYWmNIWzlVVBsrD09wiV09jeD7Oj9U1XL0lzNsekb4OaJETbEozztaP2YjPhZt1OHX9NngcRj1Zy5iYG+sHDgP8WVCNvDLj7ecbEr/k3kJNowwedpYGOderO+a3Ocd/yCxBoxEuwzEb8fmqrcWQONgN7naWLFvTe7wcrNTTAoy1pjMkCCHqUc+kGB+tboOjL0aHOMO3jxXqm1uxK8f4QrAY33/8AaiUNGPf+TIASkezsTI3zhcAsCf3Fm430p1OH4a0qzW4UtEAKz4XUyOMx/93LxwOg9ltrfhNaUVQGFkAOrMQn+8zStAiJwj3sdfptie6Zqi3PQZ5iCFrVeDHTDrp8GHYnK5sPU4O92Q1htPDMmmYF2wFPFyvbsSxgiq2zekVJi8+slYFvs9QvqizjdDXcy8Mw2BOrC8AYMvJYrTQfb4eiJKaJqRcVq4MN0b/373YCHiYPEw5GLEprYhdY3qJyYvP/vNlqG6QwkUkUM+NMGYSB7vB0YaPckkzDl4oZ9sco+S7k0UgbZMK/Q14KUVPmR3jC4YBjl+pwvWqBrbN6TEmLz6b2haQPhflo5c9l3SNgMfFjChlxMXvThaxa4wR0iRrVU8qnB3DfuRKbeDdxwqj+zoDALacMp4ICMb/NnbBuRu1OFtaCz6Xg+lRxulU7Ihno7zB4zDIKrpDh917yZ4ztyBpboVPHys8EuzMtjlaY2a0Ukh/yr6BJplxDLubtPioJpA9OchVL7uP6gsXkRAJA5RdSGOq6diGEKJuLc4c7mOQoVQelJFBTuph9z1nbrFtTo8wWfGpbZLhl7PKh6CqFUwJVbD7PWdu0kiHPSSn5A4ul9dDaMHB5HAvts3RKhwOo/5NKH1ahj/sbrLis/P0DUhbFejvJsJQb3u2zdE6w/0dEOxigyaZnO7x1UNULeGnQ90htjLe4fXOmBzuBUsL5RrA08V32DanW0xSfBQKgq0Zyh/azGgfo1qz01MYhsHMtppuy6lio6jp2KS6QYr955WjgzOH+7JrjI4QW1moNzjcagTdcZMUn7Rr1SiuaYKtgIdxQwxnVwptMz7MA1Z8Lq5XNeLU9dtsm2PQbM8qhUyuXL0+yNPwY/Y8KKqu14Hz5ahpkLJsTdeYpPioVP+ZcE9Y8Y1n9XpvsRVaYHzbbpbfZxh+TccWcgVRzwh/1oRGPTtikKcYoZ5iyOQK7Dht2N1xkxOf8rpm/J6nnL06w8R/aMBfL9Ohi+Woqjfsmo4tjhdU4caduxAJeRhrQPuz6Ypn2+aB/ZBZbNDrvUxOfLZnlUKuIIj0dUCwAW36pisGuIsR5m2HFjlRT56jaPL9KWWr55lwT1jyuSxbo3vGhrpDJOSh9PZdHDfg9V4mJT6tcgW2te3y8Oxw02/1qFDXdBklkBtwTccGZXV38cflCgCm3+VSYcnnYuJQZXzyHzIMdwGySYlPan4Vyuqa4WDNN4l1XD3lqcFuEFta4GatYdd0bLAtsxQKAkT5OSDQ2fRbwipUQptyudJgw6yalPj80OZ0nRzuCQHP9JvXKoQWXEwcqnQ8G3JNp2/ubQmbg//vXoJcbBHp6wC5gmB7lmF2x/UiPuvXr4evry+EQiGioqKQmZmp9TxKbzfh6BVlrT/diILDawtVTffH5UqU1d1l2RrD4I/LlaiQSM2uJaxC5XrYnmWY3XGdi8/27duxfPlyJCcnIycnB6GhoUhISEBlZaV288kqBSFAbGAf+Dpaa/XexkCgs+HXdPrmh7bhdXNrCat4YqAr7K0scKuuGUfztfu+aQOdi89HH32EF154AXPmzEH//v3xxRdfwMrKCt98843W8miRK7C9baRnRqTprePqKX/VdKVoNfNAY6W3m3DMjFvCgDL8yqRww3U861R8ZDIZsrOzER8f/1eGHA7i4+Nx8uTJdumlUikkEonGpyf8fqkCVfVSONoI8Hh/F63Zb2yoarqyumYczTdvx7OqJRwX6GiWLWEVKuFNza/EzVrD6o7rVHyqq6shl8vh4qIpCC4uLigvbx+Fb82aNRCLxeqPl1fPVh4P9BBj/kh/PD/COHYh1RUaNZ0Zx3jWaAmbmaP5fvydbBDt3wcKAmw3sN+EQb2pK1asQF1dnfpTWtoz34WXgxXeeLIfFhrJdre6RFXTHTXAmk5f3NsSju9nvi1hFSoB3n7asLrjOhUfR0dHcLlcVFRUaByvqKiAq2v70QeBQACRSKTxofQOQ67p9IWq1Tc1wtOsW8IqEga4oo81HxUSqTpwviGg0yfD5/MRHh6OlJQU9TGFQoGUlBRER0frMmuzRuV43pZVanY7XBRVN+LPgmowDDDNSPfj0jZ8HgeThhme41nn1cLy5cuxceNGfPvtt8jLy8OiRYvQ2NiIOXPm6Dprs+Vv/V3haMNHZb0UKXmGU9Ppgx/bJhWODHKCl4MVy9YYDjPauuPHC6pQUtPEsjVKdC4+U6dOxYcffoiVK1diyJAhyM3NxcGDB9s5oSnag8/jqPdyMqdQG9JWOX5qCyNhLuu4eopPH2uMCHIEIX8JNNvopUO8ZMkSFBcXQyqVIiMjA1FRUfrI1qyZHuENhgH+LKhGcU0j2+bohYMXylHTKIOrSIjRIaazM4W2UAnyztOlkLWy3x2n3jgTxbuPFUYGOQEwn2F3VeiMaZFe4JnAHm3a5rF+LnC2FaC6QYbDl9jfcJI+IRPmr5ruBqStcpat0S1XKuqRWXQbXA5DHc2dYMHlYFqEsjuuCqbPJlR8TJjRIc5wEwtxu1GGA+fZr+l0yfdtoXPj+znDVSxk2RrDZVqkNzgMkFF4GwUV9azaQsXHhOFxOepJh8awm8GD0iRrxa6cmwD+CqBO6Rh3O0v1xMvvWR52p+Jj4kyL8AKPw+B08R1cumWaWyvvOXML9VLlFsixAY5sm2PwqDbR/Dn7Bhql7G2tTMXHxHEWCZEw0HS3VjblLZB1RWyAI/wcrVEvbcXeXPa2VqbiYwbMNOGtlU8Xm+4WyLqCw2HUgxFsbq1MxccMiPJzQJCzDe62mN7Wyt+1jdqMC/UwyS2QdcXkcC8ILTi4XF6PrCJ2tlam4mMGMAyDWW39/O9OGvZeTr2hsr4ZBy+UAfjLj0HpGWIrC0xo23Dy2/QiVmyg4mMmTBzqCVsBD4XVjThmIjtc/JBRghY5wVBvOwz0MN0tkHXFrGhfAMDBi+Ws7HBBxcdMsBbw1Ou92KrptIm0VY6tbTOaZ8f6sWyNcdLPTYRIP2XcbzbWAFLxMSNmRfuAYYCj+VW4XtXAtjkPxb5zZahukMJVJMQYM9yZQlvMjvEFoGxFNrfodxY8FR8zwtfRGo/2VS64NObWDyEEm9KKACh9PRZ0HdcD87f+LnAXC1HTKMMveh52p0/NzJgT6wsA2Jl9A3VNxjnsnlNyB+dv1kHA45jtzhTagsflIKmt9fNNWqFeh92p+JgZcYGOCHG1RZNMbjBxXXrLV38WAgDGD/GAgzWfZWuMn2mR3rDic3G5vB5pV2v0li8VHzODYRjMi1M6aDenFRldmNXimkYcvKhcJPv8COpo1gZiSwtMbtv15OsT1/WWLxUfM+TpIe5wshWgXNKMfefK2DanV3x9ohCEAI/2dUKQiy3b5pgMc2L9wDBAan4VruhptTsVHzNEwOMiqW1S3obj11mbXt9b7jTKsKNtP64XRvqzbI1p4etojYT+ylHDDcf00/qh4mOmPDfcB1Z8LvLKJOpthQ2d704Wo7lFgYEeIkT792HbHJNj4SPKfe/25t7ELT3s+UbFx0yxs+KrdzT47Og1lq3pnkZpKzalKx3NL4zwB8PQ1evaZoiXHYb7O6BVQfD1iUKd50fFx4yZN8IPFlwGmYW3kV18m21zuuSHjBLUNrXAt48VnhrszrY5Jotq198fM0tQ2yTTaV5UfMwYN7ElJoYpRznWpxpu66e5RY4v/1T6IRY9EgAujdmjM0YFO6GfmwiyVgUyCnVbIfF0eneKwbNglD92Zpfij8uVOHejFoM97dg2qR0/Zd9AVb0U7mIhJrSJJUU3MAyD958ZhD42AnjYWeo0L9ryMXP8nWwwfogytMJ/fy9g2Zr2NLfIsT71KgBg/kh/uve6Hhjsaadz4QGo+FAALBkdCA4D/HG5ErmltWybo8G2zBKU1TXDVSTENLqUwqSg4kNRtn7CVK2fKyxb8xdNslb8r80XtfSxQAgtuCxbRNEmVHwoAIAXRweBy2FwNL8KJ6/pb31PV3x3shjVDVJ4OVjS+MwmCBUfCgDlDNfpkcoXfM2BPNZDrd5plOGzNl/Pi6ODqK/HBKFPlKLmpceCYc3n4tyNOvx2nt01X5+kFEDS3IoQV1tMHEpHuEwRKj4UNU62AvUksw8OXtZ7ZDsVVysb1HuM/TOxP53XY6JQ8aFoMG+EH1xEAty4cxdfHGNn4uG7+/MgVxA8FuKMuCC6A6mpQsWHooEVn4e3nuoPQLnmq7imUa/5H7xQjj8uV4LHYfBGYj+95k3RL1R8KO1IHOSGEUGOkLUqsHLvRb2F3KhvbkHyLxcAKGdeBzjZ6CVfCjtQ8aG0g2EYrHp6APhcDo5dqcKe3Jt6yXftoXxUSKTw7WOFpaOD9JInhT2o+FA6xN/JBi8+FggAWLn3os7ju6RfrVY7mVdPGEQnFJoBVHwonbJwVADCvO1Q39yKf+w8q7O5P7cbZVi2PReEANMjvRAbSJ3M5gAVH0qn8LgcfDRlCCwtuEi/VoPPjl7Veh6EELz60zlU1ksR4GStdnZTTB8qPpQu8XO0xqqnBwAA/nPkClLyKrR6/09TruL3vArwuRysmz4UVnwa5cVcoOJD6ZYpEV6YOdwHhAAvbcvV2u4Ge87cxMdtC1n/NW4A+ruLtHJfinFAxYfSI1aO7Y9IPwc0SFsxY2MGrlY+3F7vR/Mr8epP5wAAC0b603AZZggVH0qPsOBysOG5cPRzE6G6QYoZG0/hauWDtYD2ny/DC9+dhkyuwJiBrnjtiRAtW0sxBnQmPqtXr0ZMTAysrKxgZ2enq2woesTemo/vn49CiKstKuulGL8+HQcv9HwBqlxB8MWxa1jyQw5a5ASJg93wybQwcOjaLbNEZ+Ijk8kwefJkLFq0SFdZUFjAoU2AVF2whVtzsGLXeVTWN3d53bWqBjz71Sm8d+AyFASYFuGFT6eF0VAZZgxDdDx3fvPmzVi2bBlqa2t7fa1EIoFYLEZdXR1EIuqMNCRa5Aq8f+Ayvmrb38nSgotJ4Z4Y3c8ZgzzEsOJzcaepBbkltfjl7E0cvlQBQgArPhfJY/tjyjAvuveWCfAw76hBjWtKpVJIpVL1d4lEwqI1lK6w4HLwz6f6I76/C947cBm5pbXYcqpYPUu5I+L7ueCfif3g62itR0sphopBic+aNWuwatUqts2g9ILh/n2w++8xOHqlCocvVuD4lSrcbFuKweMwCHGzxTAfBzw33BuBzrYsW0sxJHolPq+//jref//9LtPk5eUhJOTBRi9WrFiB5cuXq79LJBJ4edHYvYYOwzB4tK8zHu3rDEDpWG5ukYPHZSDg0TValI7plfi88sormD17dpdp/P39H9gYgUAAgUDwwNdTDAMuh4G1wKAa1RQDpFe/ECcnJzg5OenKFgqFYkborHoqKSnB7du3UVJSArlcjtzcXABAYGAgbGx6FiRKNRBHHc8UimGiejcfaNCc6IikpCQCoN0nNTW1x/coLS3t8B70Qz/0Y1if0tLSXmuEzuf5PAwKhQK3bt2Cra1tt3NCVM7p0tJSk5kTZGplMrXyALRMhBDU19fD3d0dHE7vJowatFeQw+HA07N3ezaJRCKT+RGoMLUymVp5APMuk1gsfqD707ntFAqFFaj4UCgUVjAZ8REIBEhOTjapeUKmViZTKw9Ay/QwGLTDmUKhmC4m0/KhUCjGBRUfCoXCClR8KBQKK1DxoVAorEDFh0KhsIJRic/69evh6+sLoVCIqKgoZGZmdpl+586dCAkJgVAoxKBBg7B//349Wdo9a9asQUREBGxtbeHs7Izx48cjPz+/y2s2b94MhmE0PkKhUE8Wd8/bb7/dzr7uYjsZ8jMCAF9f33ZlYhgGixcv7jC9oT2j48ePY+zYsXB3dwfDMNizZ4/GeUIIVq5cCTc3N1haWiI+Ph4FBQXd3re372JHGI34bN++HcuXL0dycjJycnIQGhqKhIQEVFZWdpg+PT0d06dPx7x583DmzBmMHz8e48ePx4ULF/RsecccO3YMixcvxqlTp3DkyBG0tLTgb3/7GxobG7u8TiQSoaysTP0pLu48bCkbDBgwQMO+EydOdJrW0J8RAGRlZWmU58iRIwCAyZMnd3qNIT2jxsZGhIaGYv369R2e/+CDD/Dpp5/iiy++QEZGBqytrZGQkIDm5s43BOjtu9gpvV6KyhKRkZFk8eLF6u9yuZy4u7uTNWvWdJh+ypQpJDExUeNYVFQUWbBggU7tfFAqKysJAHLs2LFO02zatImIxWL9GdVLkpOTSWhoaI/TG9szIoSQl156iQQEBBCFQtHheUN+RgDI7t271d8VCgVxdXUla9euVR+rra0lAoGA/Pjjj53ep7fvYmcYRctHJpMhOzsb8fHx6mMcDgfx8fE4efJkh9ecPHlSIz0AJCQkdJqeberq6gAADg4OXaZraGiAj48PvLy8MG7cOFy8eFEf5vWYgoICuLu7w9/fH88++yxKSko6TWtsz0gmk2Hr1q2YO3dul1EWDP0ZqSgsLER5ebnGMxCLxYiKiur0GTzIu9gZRiE+1dXVkMvlcHFx0Tju4uKC8vLyDq8pLy/vVXo2USgUWLZsGWJjYzFw4MBO0/Xt2xfffPMN9u7di61bt0KhUCAmJgY3btzQo7WdExUVhc2bN+PgwYP4/PPPUVhYiBEjRqC+vuOdTY3pGQHAnj17UFtb22UoYUN/Rvei+j/35hk8yLvYGQYdUsNcWLx4MS5cuNClfwQAoqOjER0drf4eExODfv36YcOGDXjnnXd0bWa3jBkzRv334MGDERUVBR8fH+zYsQPz5s1j0TLt8PXXX2PMmDFwd3fvNI2hPyNDwihaPo6OjuByuaioqNA4XlFRAVdX1w6vcXV17VV6tliyZAl+++03pKam9jp2kYWFBcLCwnD16lUdWfdw2NnZITg4uFP7jOUZAUBxcTF+//13PP/88726zpCfker/3Jtn8CDvYmcYhfjw+XyEh4cjJSVFfUyhUCAlJUWjlrmX6OhojfQAcOTIkU7T6xtCCJYsWYLdu3fjjz/+gJ+fX6/vIZfLcf78ebi5uenAwoenoaEB165d69Q+Q39G97Jp0yY4OzsjMTGxV9cZ8jPy8/ODq6urxjOQSCTIyMjo9Bk8yLvYKb1yT7PItm3biEAgIJs3byaXLl0i8+fPJ3Z2dqS8vJwQQsjMmTPJ66+/rk6flpZGeDwe+fDDD0leXh5JTk4mFhYW5Pz582wVQYNFixYRsVhMjh49SsrKytSfpqYmdZr7y7Rq1Spy6NAhcu3aNZKdnU2mTZtGhEIhuXjxIhtFaMcrr7xCjh49SgoLC0laWhqJj48njo6OpLKykhBifM9IhVwuJ97e3uS1115rd87Qn1F9fT05c+YMOXPmDAFAPvroI3LmzBlSXFxMCCHkvffeI3Z2dmTv3r3k3LlzZNy4ccTPz4/cvXtXfY/Ro0eTdevWqb939y72FKMRH0IIWbduHfH29iZ8Pp9ERkaSU6dOqc+NGjWKJCUlaaTfsWMHCQ4OJnw+nwwYMIDs27dPzxZ3DjoJxL1p0yZ1mvvLtGzZMnX5XVxcyJNPPklycnL0b3wnTJ06lbi5uRE+n088PDzI1KlTydWrV9Xnje0ZqTh06BABQPLz89udM/RnlJqa2uHvTGWzQqEgb731FnFxcSECgYA89thj7crp4+NDkpOTNY519S72FBrPh0KhsIJR+HwoFIrpQcWHQqGwAhUfCoXCClR8KBQKK1DxoVAorEDFh0KhsAIVHwqFwgpUfCgUCitQ8aFQKKxAxYdCobACFR8KhcIK/w9XjPDvQ4P90QAAAABJRU5ErkJggg==",
-      "text/plain": [
-       "<Figure size 300x150 with 1 Axes>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "# #simple-plot\n",
-    "import matplotlib.pyplot as plt\n",
-    "import numpy as np\n",
-    "\n",
-    "x = np.linspace(0, 10, 100)\n",
-    "plt.figure(figsize=(3, 1.5))\n",
-    "plt.plot(x, np.sin(x))\n",
-    "plt.title(\"Simple Sine Wave\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": ".venv",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.13.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

nbsync-0.1.4/scripts/plot.py

@@ -1,15 +0,0 @@
-import matplotlib.pyplot as plt
-import numpy as np
-
-
-def plot(func):
-    x = np.linspace(0, 360)
-    y = func(np.radians(x))
-    fig, ax = plt.subplots(figsize=(2, 1))
-    ax.plot(x, y)
-    ax.set_title(f"Plot {func.__name__}")
-
-
-if __name__ == "__main__":
-    # %% #sqrt
-    plot(np.sqrt)

nbsync-0.1.4/scripts/plotting.py

@@ -1,19 +0,0 @@
-import matplotlib.pyplot as plt
-import numpy as np
-
-
-def plot_sine(frequency=1):
-    """Plot a sine wave with given frequency."""
-    x = np.linspace(0, 10, 100)
-    plt.figure(figsize=(2, 1.2))
-    plt.plot(x, np.sin(frequency * x))
-    plt.title(f"Sine Wave (f={frequency})")
-    plt.ylim(-1.2, 1.2)
-
-
-def plot_histogram(bins=20):
-    """Plot a histogram of random data."""
-    data = np.random.randn(1000)
-    plt.figure(figsize=(2, 1.2))
-    plt.hist(data, bins=bins)
-    plt.title(f"Histogram (bins={bins})")

nbsync-0.1.4/src/nbsync/logger.py

@@ -1,5 +0,0 @@
-from __future__ import annotations
-
-from mkdocs.plugins import get_plugin_logger
-
-logger = get_plugin_logger("nbsync")

nbsync-0.1.4/src/nbsync/plugin.py

@@ -1,96 +0,0 @@
-from __future__ import annotations
-
-from pathlib import Path
-from typing import TYPE_CHECKING, ClassVar
-
-from mkdocs.config import Config as BaseConfig
-from mkdocs.config import config_options
-from mkdocs.plugins import BasePlugin
-from mkdocs.structure.files import File
-from nbstore.store import Store
-
-from .logger import logger
-from .sync import Synchronizer
-
-if TYPE_CHECKING:
-    from typing import Any
-
-    from mkdocs.config.defaults import MkDocsConfig
-    from mkdocs.structure.files import Files
-    from mkdocs.structure.pages import Page
-
-    from .cell import Cell
-
-
-class Config(BaseConfig):
-    """Configuration for Nbstore plugin."""
-
-    src_dir = config_options.Type((str, list), default=".")
-
-
-class Plugin(BasePlugin[Config]):
-    store: ClassVar[Store | None] = None
-    syncs: ClassVar[dict[str, Synchronizer]] = {}
-    files: Files
-
-    def on_config(self, config: MkDocsConfig, **kwargs: Any) -> MkDocsConfig:
-        if isinstance(self.config.src_dir, str):
-            src_dirs = [self.config.src_dir]
-        else:
-            src_dirs = self.config.src_dir
-
-        src_dirs = [(Path(config.docs_dir) / s).resolve() for s in src_dirs]
-
-        store = self.__class__.store
-
-        if store is None or store.src_dirs != src_dirs:
-            self.__class__.store = Store(src_dirs)
-            config.watch.extend(x.as_posix() for x in src_dirs)
-
-        for name in ["attr_list", "md_in_html"]:
-            if name not in config.markdown_extensions:
-                config.markdown_extensions.append(name)
-
-        return config
-
-    def on_files(self, files: Files, config: MkDocsConfig, **kwargs: Any) -> Files:
-        self.files = files
-        return files
-
-    def on_page_markdown(
-        self,
-        markdown: str,
-        page: Page,
-        config: MkDocsConfig,
-        **kwargs: Any,
-    ) -> str:
-        if self.__class__.store is None:
-            msg = "Store must be initialized before processing markdown"
-            logger.error(msg)
-            return markdown
-
-        src_uri = page.file.src_uri
-        syncs = self.__class__.syncs
-
-        if src_uri not in syncs:
-            syncs[src_uri] = Synchronizer(self.__class__.store)
-
-        markdowns = []
-
-        for elem in syncs[src_uri].convert(markdown):
-            if isinstance(elem, str):
-                markdowns.append(elem)
-
-            elif markdown := elem.convert():
-                markdowns.append(markdown)
-
-                if elem.image.url and elem.content:
-                    file = generate_file(elem, src_uri, config)
-                    self.files.append(file)
-
-        return "".join(markdowns)
-
-
-def generate_file(cell: Cell, page_uri: str, config: MkDocsConfig) -> File:
-    src_uri = (Path(page_uri).parent / cell.image.url).as_posix()
-    return File.generated(config, src_uri, content=cell.content)

nbsync-0.1.4/tests/test_plugin.py

@@ -1,108 +0,0 @@
-import os
-import shutil
-import sys
-from pathlib import Path
-
-import pytest
-from mkdocs.commands.build import build
-from mkdocs.config import load_config
-from mkdocs.config.defaults import MkDocsConfig
-
-from nbsync.plugin import Config, Plugin
-
-
-@pytest.fixture(scope="module")
-def config_file():
-    return Path(__file__).parent.parent / "mkdocs.yaml"
-
-
-def test_config_file_exists(config_file: Path):
-    assert config_file.exists()
-
-
-@pytest.fixture(scope="module")
-def mkdocs_config(config_file: Path):
-    return load_config(str(config_file))
-
-
-@pytest.fixture(scope="module")
-def nbstore_plugin(mkdocs_config: MkDocsConfig):
-    return mkdocs_config.plugins["nbsync"]
-
-
-def test_nbstore_plugin(nbstore_plugin: Plugin):
-    assert isinstance(nbstore_plugin, Plugin)
-    assert isinstance(nbstore_plugin.config, Config)
-
-
-@pytest.fixture(scope="module")
-def nbstore_config(nbstore_plugin: Plugin):
-    return nbstore_plugin.config
-
-
-def test_nbstore_config(nbstore_config: Config):
-    config = nbstore_config
-    assert config.src_dir == ["../notebooks", "../scripts"]
-
-
-@pytest.fixture
-def config_plugin(tmp_path):
-    dest = Path(tmp_path)
-    root = Path(__file__).parent.parent
-    config_file = root / "mkdocs.yaml"
-    shutil.copy(config_file, dest)
-    for src in ["docs", "notebooks", "scripts", "src", "tests"]:
-        src_dir = root / src
-        shutil.copytree(src_dir, dest / src)
-    curdir = Path(os.curdir).absolute()
-    os.chdir(dest)
-    sys.path.insert(0, ".")
-    config = load_config("mkdocs.yaml")
-    plugin = config.plugins["nbsync"]
-    assert isinstance(plugin, Plugin)
-    plugin.__init__()
-
-    yield config, plugin
-
-    config.plugins.on_shutdown()
-    sys.path.pop(0)
-    os.chdir(curdir)
-
-
-def test_on_config(config_plugin: tuple[MkDocsConfig, Plugin]):
-    config, plugin = config_plugin
-    plugin.on_config(config)
-    assert plugin.store is not None
-
-
-@pytest.fixture
-def config(config_plugin):
-    return config_plugin[0]
-
-
-def test_build(config: MkDocsConfig):
-    config.plugins.on_startup(command="build", dirty=False)
-    plugin = config.plugins["nbsync"]
-    assert isinstance(plugin, Plugin)
-
-    build(config, dirty=False)
-
-
-def test_on_page_markdown_fallback():
-    class FakePlugin(Plugin):
-        pass
-
-    plugin = FakePlugin()
-    plugin.__class__.store = None
-    assert plugin.on_page_markdown("abc", None, None) == "abc"  # type: ignore
-
-
-def test_src_dir_list(config_plugin: tuple[MkDocsConfig, Plugin]):
-    config, plugin = config_plugin
-    src_dir = plugin.config.src_dir
-    plugin.config.src_dir = ["a", "b"]
-    plugin.on_config(config)
-    assert plugin.store
-    assert plugin.store.src_dirs[0].name == "a"
-    assert plugin.store.src_dirs[1].name == "b"
-    plugin.config.src_dir = src_dir