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.19.tar.gz (15.1 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.19-py3-none-any.whl (596.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.19.tar.gz
  • Upload date:
  • Size: 15.1 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.19.tar.gz
Algorithm Hash digest
SHA256 d999f567c16054e0f75b808a54b91ac38a22715c8529f38a95da0592ef0d3afd
MD5 a254c3d3f1f3a78f28b184f276b3cd55
BLAKE2b-256 f25791b111762cfc4674326bbee0149631c336e416f14f08a853d9e688d13616

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 b08e5907cb22dab6ff7fc9a46a36c304a5692e2eab3cff07a5b985f6722336d8
MD5 c2412a8dec7a5f3a595cd523f1c46160
BLAKE2b-256 d94b00e7de718403ae9dcbbfe1a211efa913ab6a04a3a3d5cb9e9e891fa4d6d9

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