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.27.tar.gz (18.8 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.27-py3-none-any.whl (612.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.27.tar.gz
  • Upload date:
  • Size: 18.8 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.27.tar.gz
Algorithm Hash digest
SHA256 5de378047378a1ebafcb09c19c76ecf8160a625a6ea96b97d7b4c2d66dc1cb8d
MD5 79251f90167af2c7b4026b92eae0a3af
BLAKE2b-256 ecc06b290a1d0cb4186c4be0344ceacd6fdfaa061b6e6c524d74a4ba09da333c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 4f8f0add8846592bf88baeacc855686922240a81ce69f96e7b0cb3e4b4655e2d
MD5 3c6dd68db925b8a3b542663d982992bd
BLAKE2b-256 43565eb01ec7ae82d86d4579695381238e0e7687b9aa1f55bb268b016ee98c4a

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