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.10.tar.gz (11.5 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.10-py3-none-any.whl (586.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.10.tar.gz
  • Upload date:
  • Size: 11.5 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.10.tar.gz
Algorithm Hash digest
SHA256 410f9bf5f8c041644a910f1f8dcd61f9c2dd70c097e48d5ab1fe6e024657281d
MD5 86cc88216d3502bf4ba4cf9495919f59
BLAKE2b-256 ee8157650f89691d7f14f4414c79cdc32872472b35afb978602b7a1c760e3128

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 5c179b62ad671c0260e47dc29372b5cc73160b8f9216a3f889b881f098c5ef4d
MD5 0f7cb67645fcbcf5908face6a847161a
BLAKE2b-256 40492788119322086267399e98c90d274780ea152dc99af7a42809f00ff9c2eb

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