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.2.2.tar.gz (20.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.2.2-py3-none-any.whl (645.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.2.tar.gz
  • Upload date:
  • Size: 20.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for munchboka_edutools-0.2.2.tar.gz
Algorithm Hash digest
SHA256 ad73f089a7e25f576bc87cdfe8a082e2a02a58f77b73dbd9145e8186b3243907
MD5 97ef031017c1cd1758d2b6ecc1ecc570
BLAKE2b-256 b583f2091dcc18a891234d2d8b5ba2197e0b9af86cf089e0acf987f1cbbec406

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 abcf8c5290b56269d6789ec46b1fff1f34006f2a0765347c0ce09dbb0907e145
MD5 8d1913579a655b8e1385b2057057f465
BLAKE2b-256 f4149a157f42353bab719d5e66a4247325e90f3eb005d3789684e5de8c8923a6

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