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.24.tar.gz (18.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.24-py3-none-any.whl (608.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.24.tar.gz
  • Upload date:
  • Size: 18.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.24.tar.gz
Algorithm Hash digest
SHA256 5ff9883da8d1474a437a6bef8ceaa30cdf52e3a740986a4ae027b07baf860e21
MD5 0471f4c362be6f055a052377bd53b6e2
BLAKE2b-256 01714a53c45b23478fc1fa49c55719c8f793bc1985f871b5c1cc4ca4e985c1e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 4c1f40339564b2c795393110fcd32dd30147dc3497c0d56de189cf4da9642bbf
MD5 225814659b6e253fdb10940db9ba7695
BLAKE2b-256 c31291f71fc278820771023041c85a5d8280012ee496c15124ff1448310e8f83

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