Metadata-Version: 2.4
Name: munchboka-edutools
Version: 0.1.3
Summary: Sphinx/Jupyter Book directives and assets for Munchboka and VGS books
Project-URL: Homepage, https://github.com/reneaas/munchboka-edutools
Project-URL: Issues, https://github.com/reneaas/munchboka-edutools/issues
Author: Rene Aas
License: MIT License
        
        Copyright (c) [2024] [René Alexander Ask]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: directives,education,jupyter-book,munchboka,sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Requires-Python: >=3.9
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.23
Requires-Dist: plotmath
Requires-Dist: signchart
Requires-Dist: sphinx>=6.0
Requires-Dist: sympy>=1.11
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: build; extra == 'dev'
Requires-Dist: jupyter-book; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# munchboka-edutools

Reusable Sphinx / Jupyter Book directives and assets for Norwegian educational content.

## Install

```bash
pip install munchboka-edutools
```

## Usage (Jupyter Book `_config.yml`)

```yaml
sphinx:
  extra_extensions:
    - munchboka_edutools
```

All packaged directives are auto-registered. Static assets are placed under `_static/munchboka/` during the build.

## Development

Clone and install dev extras:

```bash
pip install -e .[dev]
```

### Local demo book

Build the embedded demo book:

```bash
jupyter-book build book/
```

### Adding a new directive

1. Create `src/munchboka_edutools/directives/my_directive.py` exposing `setup(app)`.
2. The package auto-loads modules under `munchboka_edutools.directives`.
3. Add an example page in `book/examples/`.

### Testing

Run tests:

```bash
pytest -q
```

### Releasing

Tag a version (`v0.1.0`) and the GitHub Action will build and publish.

## License

MIT
