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.34.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.1.34-py3-none-any.whl (624.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.34.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.1.34.tar.gz
Algorithm Hash digest
SHA256 3719742f4adf35b01bd8d344c9eae7721779c3a5d8cb5330ef5edd9d4facaafc
MD5 29ccf2492f2c178743edd858b40f550f
BLAKE2b-256 09a3906ff8bdbe9c6521e28f0e16fc5eb571981230b3bb9c1017912cda983e73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.34-py3-none-any.whl
Algorithm Hash digest
SHA256 6724238ec843ba6452bd4391855316504349b84c1a43093c4dcd2b8177697de8
MD5 027eb93e654c887287796e5d75cafa6f
BLAKE2b-256 dba508928973d4e8c9141a58ad8749ddd7e7ae391faa4c15a3eb3df60c8ea331

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