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.7.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.7-py3-none-any.whl (645.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.7.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.7.tar.gz
Algorithm Hash digest
SHA256 03f5304f6a1622c1135bbd5c3e87c68fdc6a46f146885b21940d934a040063f1
MD5 1ff1fe51bc5260c861e3124645057251
BLAKE2b-256 a23b553cdc659fa91782e920de2fd187c864ea85c072932d76ff057df3d23a90

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 39430fd0d3c831b36bbf150ae115e069ac0e4a034e505bb84616958b57e55785
MD5 1815284bfb9e4490bb9ea7f0171891f6
BLAKE2b-256 1059993a6bab26176017662c91e173f6a1a45d2f9a00bd0c2d8408dd666f6b36

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