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.5.tar.gz (10.2 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.5-py3-none-any.whl (581.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.5.tar.gz
  • Upload date:
  • Size: 10.2 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.5.tar.gz
Algorithm Hash digest
SHA256 96670506c370774288992d83b0aa78f91cb7a8325accfdb355443b2faf06fb0c
MD5 2c30051da697a06da8aa3b2a4f372ca4
BLAKE2b-256 541a99c679223666c92631720cc8f73a79087dd39bd1dd0617e6892f7c6dd38f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 91f76d511d7dc4525743c750d1b293aedfaaf5007cf18c3eeeac671d6353bc17
MD5 c7cc8dfb42c30d5383aa61061ca5cf73
BLAKE2b-256 ba9d8e0ba01ac89a131d6ec4f628cd0e9901fa6c964228f707d42691e0421b83

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