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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.6.tar.gz
  • Upload date:
  • Size: 10.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.6.tar.gz
Algorithm Hash digest
SHA256 f60f045cf6bebadc083e2bf95b0a6c1769f99c89c20bbb6a96fc5036cb71411d
MD5 21ff0501d7bd0b6f12d3027c7c989af5
BLAKE2b-256 a3b2e91f96f66824d44298a0a07927c8bd934e6cd0755d93f5675d6e19c677a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fa8008893800b24e97592b94ffd2502272d02ca0f826c6424b3dc4a67193f1e6
MD5 b4f5e371c90cffb6e83e214d39530ce4
BLAKE2b-256 b7f4a617855d4f8ccea0f8b2827438e00bfe22c11fa7fe4eff1d98762bf0b918

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