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.8.tar.gz (11.4 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.8-py3-none-any.whl (586.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.8.tar.gz
  • Upload date:
  • Size: 11.4 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.8.tar.gz
Algorithm Hash digest
SHA256 f2abebdfa94c473070e38e7862ea07d3d877d4470446eb0411522fc436b18686
MD5 6aa6e47e09c8e84a15d3a67d023aec44
BLAKE2b-256 9a096256d5fcb6931ed1973e189ccbc2a481c1ed2b4de0ae239479ab142290b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 710875e1844e0e6eacf9ef4e99b37e18fa18573fec224ecbed2bffb04dbdf641
MD5 fc6f69480f85068e847e26897259b821
BLAKE2b-256 ed267dcc509b650301c228ebf404b5edbde39d1477b71683ec511dc2f7e53579

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