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.17.tar.gz (13.3 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.17-py3-none-any.whl (589.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.17.tar.gz
  • Upload date:
  • Size: 13.3 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.17.tar.gz
Algorithm Hash digest
SHA256 a51db0bad1c05097b0d647e71c0a710d9cc7260775bf0897329f8bc7e5662bd2
MD5 54efa8316c9ded29ad2df858b3cdc399
BLAKE2b-256 68d1686a166946649a59ea497c0b0a283d11befa28a7ee2237450d403e6a3d73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 cfa433e59556ba46c85e4b1bd33bd6f2fc37ca403f47744ae734809170087981
MD5 f9c1b6cd10186b412eaa56074edbbc2c
BLAKE2b-256 ff0e57664a655eb5b1ef774e4d23c66977ccbdfc41cf1e8e569e1f702129dfe1

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