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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.31.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.31.tar.gz
Algorithm Hash digest
SHA256 e2c0cddc28c340ea91b435fe04674d73957dd16ae56127bb9fb4cadb48e2d51d
MD5 bfd02b110a767fa41f1c1a8294be7f04
BLAKE2b-256 efbcebc8b415ba371e76ff5e25064241dc8cd32c232e49bbebcddcd5ed2b831e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.31-py3-none-any.whl
Algorithm Hash digest
SHA256 58d129b4d6a51ed89294fdf0e27db5fb153acb1402a742190c612e604c5e0998
MD5 6ee80becfd5ec270079fdc2f62846bdc
BLAKE2b-256 e18648650794ab6a5488fe5e9bd4a05808330eef8c29edd74f435499dfbb619a

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