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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.28.tar.gz
  • Upload date:
  • Size: 19.2 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.28.tar.gz
Algorithm Hash digest
SHA256 4b7c0f21d58ed799870234192e5927babbdb6c3042a7f6128fb82bfc3d8283ee
MD5 d822b51cdcd1f44f300d95927bbf06c4
BLAKE2b-256 f666ffbd31f279d9d5ba28ffcf1470d859d3c3abc01a66d7e74d0ef54b70dd6a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.28-py3-none-any.whl
Algorithm Hash digest
SHA256 ea54d88a7c2765581f35554970784aea2e5e0a52241fe99627ad1925b8f6a326
MD5 09e64acffb4c97ee41b240e5249414ed
BLAKE2b-256 dd8cd6788e46c20e8407f30268aa114dc324f0dce0876328a20db3260d214b95

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