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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 45ad03983640b0808f7670b92bc67159d2e6d1b46562ba6ed2c0f2c65276abaa
MD5 b6a1daaabdcf19b1f5fc6d2beaa95eb1
BLAKE2b-256 6c296374bd6694033572acfbc1cf783116a2b5937a86ed7bc90571f0975dc4b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 60a38a6a1d656efd486ba165b7a1c8a598c04454e10e0eace4ad4e7313f4752e
MD5 c449af2b8d9f0e19bcf7c128d79c6d89
BLAKE2b-256 106c8c8fad09530ab0bdfb45f6160b1ce21fe55ce0e423dfbe58473c0c8138fa

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