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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.12.tar.gz
  • Upload date:
  • Size: 12.2 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.12.tar.gz
Algorithm Hash digest
SHA256 476990426a2ec54f4f3ed845cae127015e2bcda2565b299580f0a299afd39247
MD5 9a4cb983883bfcf79c53a697bba8307a
BLAKE2b-256 7989c9b667bccad663e066c8f0bfe898861250e98393b628ff32394cd85c8dbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 40e271ec8466260ca430613b225031e8e34202769bf2d748ef0bbab598c4fa26
MD5 c4786f59c9acdc2da75ae5f33f78a2e9
BLAKE2b-256 d4dc648499a0f74ed05b4abc6f80113fbab8cb7968d1ccfd3f1d8335ef05dab4

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