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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.33.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.33.tar.gz
Algorithm Hash digest
SHA256 59f67280088a1e6f4261a0e52b5581aefaaf598dce5c59dfacdc87d3be9cdce7
MD5 b8022ef6c3535e74c558a24e0cc04b17
BLAKE2b-256 d2ff2ebf8ff5ed40696bbcd36026d4e0f77ad623cddfab0ea351db5df372d8ab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.33-py3-none-any.whl
Algorithm Hash digest
SHA256 8c15260ff185f9b53342df0af977dee746c75b7dffaf04fc44c9335009583760
MD5 4b2cb075de4cae6c12e7a47f8d7b75a3
BLAKE2b-256 d42d320ad009b9ece16d179d81a79ec743eb9e7d81b79a3e10f7e7a1fd9d4bd8

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