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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 2f5194946c42c60c9768c7326d10ecc69d8f89e684bc63b6252a7f83aa572655
MD5 b6b3a8d2e11326da4c3b09858186a5b4
BLAKE2b-256 f523d479418ea960dcfeeb9ee597f782a1a1c7d09c5c9564525c3090e97dd422

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62d6878794878c4661d1929c982e587c82b06cd8802f3e5cd34036bb73c95199
MD5 bac376e860fb36d3e976fb7d18df28b4
BLAKE2b-256 12be7ff3e3b900b69deb70e3e071ded6fbdff0fdf3953bfc2e8d0ec7569a9dfa

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