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.2.6.tar.gz (20.0 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.2.6-py3-none-any.whl (645.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for munchboka_edutools-0.2.6.tar.gz
Algorithm Hash digest
SHA256 13c712ee375b81871d56bf5a6b3fad9052afd0bf13288b9a2da1a56dff5e0a3b
MD5 45e2f084b699d0afab1222cb30e64c1b
BLAKE2b-256 a6b4d7967e32d87c39146e236908a9d8d758811e09b8423c6c16cb0884813304

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ade2cd1c72b1fcd44fd07a24e8f0cbfb00a6b6f3c023be98c5c9c0de52212060
MD5 038b941a46dd3f134f5e56a06f26f9f4
BLAKE2b-256 546bb1b7325f0011af4729169da2e3e29db28ac25944bc7aaf029c0ec0f3d932

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