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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.2.1.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.2.1.tar.gz
Algorithm Hash digest
SHA256 8082611c3eff62df51e963919dbaecb2009d94d09a0f073315ccedf00fd5bbee
MD5 56e823cbc8411d8b117ca4c35bb45ce1
BLAKE2b-256 ed372002b3f57201127d62ac480256c30b5b965a24902a46df3086b59b11da84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 346054a5b79e43bb0f5fcfef330bb7a1bf76810b5d0257b44e7177ffb7b81cee
MD5 fdf20c833a1a0562f49758a9b1f25aed
BLAKE2b-256 2fe9c4d568906a4a4f56692edefa4eb9aeeda995714483f80ec1b71ba573137e

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