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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.22.tar.gz
  • Upload date:
  • Size: 15.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.22.tar.gz
Algorithm Hash digest
SHA256 bb3c8aa9ebf8e9b8d3ab792d6f8d19a7f337d55f12bfc268f8251b55b6e9f0ea
MD5 47d889ed2d3538213c9e3e89d021a4e2
BLAKE2b-256 2af2f9af9788a693b0839e3a5c969e9e00df17a01517a3da79c5ae4b45acfe3c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 0c771dfc90d479f5b15cf8f97905ea047e841dbf2dbb58bfed565f61a927d8a5
MD5 d2dd34c030a904e9256f8f9b5f8d901b
BLAKE2b-256 1958c53a4a2590659f8a3e90268e132063f3aece70e56b418245394275b7ba15

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