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.16.tar.gz (12.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.16-py3-none-any.whl (589.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.16.tar.gz
  • Upload date:
  • Size: 12.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.16.tar.gz
Algorithm Hash digest
SHA256 0521ba967677da097ce9e9e87584eac1338651dcb8d63985fe3f54e420ca5593
MD5 957062fafcc68d8f8e45830ad9262e06
BLAKE2b-256 6b880563ba5a14197ed462fb6e3c9b64fb27ec1136451126b85d40fda365b6db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 c7ca5f05271eaed3911ebca828c6fcc9cb03d309126a5ecc419db759c3fb3ba2
MD5 f1c85de5a673550eac45488609e6e592
BLAKE2b-256 f27a1211a99e030993def67da717b9e44a54b23c8104ccaa5c1cc40ff3a73ca1

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