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.5.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.5-py3-none-any.whl (645.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.5.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.5.tar.gz
Algorithm Hash digest
SHA256 3383616703dfef68b31df0e024f1aae9115e2f48fe4025941541d2269a127f38
MD5 a072d576ee030b7c7b08c0d1c06b4761
BLAKE2b-256 765d68fb874c3c6f71a5f5bd77e1cc70cae9cb4cedaeba642e3c5117de3ccf45

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b44e64ff961647747124c21039bbeede2fb9e0929b7826c66cd98b68a2537b4b
MD5 4a611ccfeec408d82c095f251149f840
BLAKE2b-256 41327522eb078a0a9957585b89ba2402b30f78dcbcd360632debe14676e5fa37

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