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.26.tar.gz (18.6 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.26-py3-none-any.whl (610.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.26.tar.gz
  • Upload date:
  • Size: 18.6 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.26.tar.gz
Algorithm Hash digest
SHA256 e260924fa83ce5ef045543867e69d86645ab3141855c841b4a818b75eaa2a5c5
MD5 d474b2e1ad98fa6d264d2e8baad55e48
BLAKE2b-256 4d252d68c4f56bd9b844c6e77f92680d26eb9df49da54f672bd1378053ea85a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 88d1e64e3570d2b550f494a4809f1323d30b7f7d688103610d7e31d0f6187936
MD5 8e4fbd353eeb8a77f05b8bd33fcc21b3
BLAKE2b-256 a8e695e44693d5982a4f95c31ee1a8dbd359d2e9660f2d6a0b4ce9c1f1fcdcf6

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