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.29.tar.gz (19.2 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.29-py3-none-any.whl (614.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.29.tar.gz
  • Upload date:
  • Size: 19.2 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.1.29.tar.gz
Algorithm Hash digest
SHA256 829b3bfb61ecfea163b969815ddf0b8d7916b8b19b980edf272351c652aa5105
MD5 e6a9e89776d49cd9e9537b61c5ff4a5e
BLAKE2b-256 7b7f132c09638200cfa688707c70fda8b6ba923394d396b5594b3107a034053f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.29-py3-none-any.whl
Algorithm Hash digest
SHA256 bdc75c36d572b6b10398e8ef1c048d95b38f4708d4649324e3eecde2d7be1427
MD5 70e4ca0828cb6f264a2199fb4c4df7a5
BLAKE2b-256 845a3d2904f5d7ffe7fc9cd2c436eb744abf3c8f250f9317c211b20195144c63

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