Metadata-Version: 2.1
Name: nbdev-mkdocs
Version: 0.0.1rc1
Summary: Extension of nbdev for generating documentation using Material for Mkdocs instead of Quarto
Home-page: https://github.com/airtai/nbdev-mkdocs
Author: airt
Author-email: info@airt.ai
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python mkdocs material
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

nbdev_mkdocs
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

This file will become your README and also the index of your
documentation.

## Install

``` sh
pip install nbdev_mkdocs
```

## How to use

```` python
def f(s: str, i: int):
    """ A simple function
    
    Params:
        s: a name
        i: a number
        
    Example:
        ```python
        s = "Hello World! "
        i = 2

        print(s * i)
        ```
    """
    print((s + " ")*i)
````

You can use the following code to run example from the function’s
documentation above:

``` python
from nbdev_mkdocs.docstring import run_examples_from_docstring

run_examples_from_docstring(f, supress_stderr=True)
```

<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace;font-size:.68rem">Example:
<span style="color: #00ff00; text-decoration-color: #00ff00">───────────────────────────────────── </span>code<span style="color: #00ff00; text-decoration-color: #00ff00"> ─────────────────────────────────────</span>

    s = <span style="color: #008000; text-decoration-color: #008000">"Hello World! "</span>
    i = <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">2</span>

    <span style="color: #800080; text-decoration-color: #800080; font-weight: bold">print</span><span style="font-weight: bold">(</span>s * i<span style="font-weight: bold">)</span>

<span style="color: #00ff00; text-decoration-color: #00ff00">──────────────────────────────────── </span>stdout<span style="color: #00ff00; text-decoration-color: #00ff00"> ────────────────────────────────────</span>
Hello World! Hello World! 

<span style="color: #00ff00; text-decoration-color: #00ff00">─────────────────────────────── </span>stderr supressed<span style="color: #00ff00; text-decoration-color: #00ff00"> ───────────────────────────────</span>
N/A
</pre>
