Skip to main content

Sphinx/Jupyter Book directives and assets for Munchboka and VGS books

Project description

munchboka-edutools

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

Install

pip install munchboka-edutools

Usage (Jupyter Book _config.yml)

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:

pip install -e .[dev]

Local demo book

Build the embedded demo book:

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:

pytest -q

Releasing

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

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

munchboka_edutools-0.1.3.tar.gz (10.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

munchboka_edutools-0.1.3-py3-none-any.whl (581.3 kB view details)

Uploaded Python 3

File details

Details for the file munchboka_edutools-0.1.3.tar.gz.

File metadata

  • Download URL: munchboka_edutools-0.1.3.tar.gz
  • Upload date:
  • Size: 10.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for munchboka_edutools-0.1.3.tar.gz
Algorithm Hash digest
SHA256 de19fcd19d3d71de49530d76a92f5b84c6d2bad51c0391620d18bb419aa15563
MD5 d286fa50ad248b4dc21f6c25d27a8a4d
BLAKE2b-256 e38cce96b8fadbf340282126e676f10ee6bd711416b3b29090efd7a3a529d0bb

See more details on using hashes here.

File details

Details for the file munchboka_edutools-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for munchboka_edutools-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 28a7a6e67c75bce23bbc0bd8f59c74d2f2034155482afeb8ad3bbae4f7298551
MD5 e43be286c352552cd2977aa53f34cfa5
BLAKE2b-256 bd57c88c2089e1d5d52045854f03f192d06f79acc3694936b86383f85ed0574a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page