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.18.tar.gz (13.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.18-py3-none-any.whl (589.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.18.tar.gz
  • Upload date:
  • Size: 13.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.18.tar.gz
Algorithm Hash digest
SHA256 127c2438877cf1e9f4764cc216a3aab4d7cd375d7bfbb0d52f6ce3bed0d92962
MD5 58d155499fd67ac15652d934ea7394dd
BLAKE2b-256 7a7ed0079d15a01f6e850121ae57b216479041fa9dd24564b8a8b23b19cebc52

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 3bceb4b041aca12d1bf8a0f4be853c2f198a9aab85a946a3404331b092d549b3
MD5 7beaf212eed0db8d13b7a04329d59d08
BLAKE2b-256 90425cc85c03699dcd4d97918a04bb656adf913f1b5984046884e149028dd565

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