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.9.tar.gz (11.5 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.9-py3-none-any.whl (586.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.9.tar.gz
  • Upload date:
  • Size: 11.5 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.9.tar.gz
Algorithm Hash digest
SHA256 ec7060f3a90238f03d3d3e53de551219cd5f71c24234bef8968ab31826eee030
MD5 92f1394c96acc20effbfa950371b04be
BLAKE2b-256 3bf072192008e251361b41dea8c5e9d0f34c3ee15e69416df1b89b21c37cb81b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2000b108783ff713ed396c8f23da387399ea9760f8d8b16121ecc4ddd6742da2
MD5 394fb96dc83921c84cecc5746b4b18cd
BLAKE2b-256 653247b743b6be2e675f66754621c5490b1e716cff113ff1a23ac39d7c5ec7b0

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