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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.7.tar.gz
  • Upload date:
  • Size: 11.1 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.7.tar.gz
Algorithm Hash digest
SHA256 dd2006258888ce6383923d173ace2cc0c87917e2fb3802c09bd222066c5b4364
MD5 a8852694e1eee3eb5e1c117f03920d1d
BLAKE2b-256 a81687a0592a2261a94d58999ec18fa864f4bb971f6caf0a35249249f8653f6d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f761f9898fae11772ee968ee373b71f59bf78f1cac1dfc279f2055474d84e732
MD5 7dcdbd880e97cba70fcf53017b173cef
BLAKE2b-256 982cbcbf83164e7a5d2d72edfac40266ceb986e36be193e605bd9ca4fde36621

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