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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.25.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.25.tar.gz
Algorithm Hash digest
SHA256 9a9c0d23c1967b754a6a3b1c2ecb00c5690fc170ceda56afc1c9ed390f53f563
MD5 ad10decf85b9373697880c8e9a7b17c3
BLAKE2b-256 da852d292001cc332a39122f1320afc10aee6e07756e71c5f51dd469de46059e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 323af18135c86ce80a31f589d38ae3edf11f345ff27faf154dc91db0da97f9f2
MD5 71c3857e575404aab9d888e6448c256a
BLAKE2b-256 b1cb3befd32bbb5174a21d0e159bc14317edce6e97f32e63c92a20f60055666d

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