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.23.tar.gz (16.9 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.23-py3-none-any.whl (603.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.23.tar.gz
  • Upload date:
  • Size: 16.9 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.23.tar.gz
Algorithm Hash digest
SHA256 dd468bcba5030b611a7c9ed9da3bf886dcfc4f1d28bdb4dd65ee817b5e942d44
MD5 1e6f1d78c652cb417cab2d2bd6e18278
BLAKE2b-256 9017609a82f43799874855677e3a7b779764c22e83e0bf0a1e1c3ced48085aaa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 80a6e8fd8ed817b40a9aaf7eefc790b3856d04d74ff6c4be4e56b033a78262ab
MD5 8f720479d231c9ca65cbae1e6ef40054
BLAKE2b-256 87cb4984d4e6a7c7c27962b4f0f187ba32089e4c39caff77106912afbeca8011

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