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.20.tar.gz (15.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.20-py3-none-any.whl (596.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.20.tar.gz
  • Upload date:
  • Size: 15.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.20.tar.gz
Algorithm Hash digest
SHA256 6b5ee2d2056b24357fae4bb3868ecb2830e0d56bb95dfd31e7842b87f95e8612
MD5 4a25225fcdb3d40e095fbcf60f315429
BLAKE2b-256 06e2a577c895c557700903d47e7a0018f8bc72764659f4b80de4868d9336aeb4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 28f5c8c9d97eb02686fece4c6d6944d0320904ac497bb1a2c9371e26ff2a9c97
MD5 af0c2d3f46d7431800270eabcb1cf59e
BLAKE2b-256 b794eb2deeff186b8b95290bf4c125ab18081ffa74a89ee9bc1eaa8c2fccc93e

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