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.21.tar.gz (15.3 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.21-py3-none-any.whl (596.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.21.tar.gz
  • Upload date:
  • Size: 15.3 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.21.tar.gz
Algorithm Hash digest
SHA256 8b8a6e304c82599b555560d8d69becb9f0b648be2ebcd286a09fd497769121ec
MD5 ab52d6cb4ad6746858e45b342b02d2f8
BLAKE2b-256 e73f86ed9e955b71dca0290ea526cc759b5a6af058f98506a98d26efe6e17527

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 eb670c0bcaf3a735f77f43b7b05208d97f01dca8a6f6e2171a42e0dad28f76f2
MD5 408fed515d5747af1dd5a456044ae708
BLAKE2b-256 e5ea08c57bd082e08c624b95a984ee074e7f4bf1871012457ae4211f7a3ced76

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