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.2.tar.gz (7.0 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.2-py3-none-any.whl (595.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.2.tar.gz
  • Upload date:
  • Size: 7.0 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.2.tar.gz
Algorithm Hash digest
SHA256 c79a8ea92b6d4bf137b865c932e4e6ac7c63e26b7dd4decb4e2d9a42af5339a9
MD5 801bfa8a5e8ef4f8a88ad3471ed69760
BLAKE2b-256 a19267c0ce8fd13378a93d6c5f53a724008b6e0cbff983f181466664238fa779

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 62079b80d6c5fc46e28fad137de8d1b2192930d1a51967a1cf3745eefc3dd2d4
MD5 bd382469f132c6b05976f8c8407a43d9
BLAKE2b-256 00e048433c071cdae9571aacf8cd029aac91298e2e2dde7a1ce6dc8b0fb659fc

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