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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 edc1a14f33fec85d3dd1c7e91657f7be762a3754b238a53189abce57644d1517
MD5 b531ed3b83652c339acd71edc60f2c1d
BLAKE2b-256 c1ac01510806aedd645c3fcd3f7109577c7721e45513e081647cf6125e036b16

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1d849fb103fd584bb7d6482cc6aa5771c3d27db547fb9d6396879df12df1ac1d
MD5 8929f210bb7577cd415e5de94ed2ea67
BLAKE2b-256 4943aa6f0d632a7529e5c93e8c28ef5afae1a8468c03e867af5c132dfe359321

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