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.0.tar.gz (7.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.1.0-py3-none-any.whl (595.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.0.tar.gz
  • Upload date:
  • Size: 7.0 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.0.tar.gz
Algorithm Hash digest
SHA256 9a3f3b2fce3791d526a4915c2522adb1881bf4114e0fccdefddeb106b772e704
MD5 80533219b54800d7a3b51de60177043b
BLAKE2b-256 3307d5c5d6b7c39108190c6c6e89d1491b2e62956c894a7cae7be845418d0feb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4287bcf15e0cf40a500b9514922e873f2e43ac07c521664a24a0f0ce4b8603b
MD5 f838537002d57c6f55761857d0b0511d
BLAKE2b-256 a33fb188e440057ea968c09ba2ee66295024b6d434eb0d3c08a835c965581dc0

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