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.15.tar.gz (12.7 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.15-py3-none-any.whl (588.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.15.tar.gz
  • Upload date:
  • Size: 12.7 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.15.tar.gz
Algorithm Hash digest
SHA256 519146714053847417650c0ecc86c3f8f18f6904a30ffd89a83faf3fccb1e7b7
MD5 9fc2c8bceeb3606a5ab17f44488f2457
BLAKE2b-256 719303524f895d1cf666798503ac0030039f8482088d42b5259ee480682c6fd7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 996693e4a1f8689c0518622a01713a559337070a18d7d3c36c22f73ae27058b2
MD5 60aed2c7ebb62123cdb9b99c8a0dd5eb
BLAKE2b-256 00f7dfe8c1d7800a6dfd7c314b38ff7a70c7e68cfbca8f847ee5adf78356a9f1

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