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

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.4.tar.gz
  • Upload date:
  • Size: 10.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.4.tar.gz
Algorithm Hash digest
SHA256 996d2c445309a8c9732c01b1f34cbfbf3c06d2f9a2a9233fddc48d0f37edcc55
MD5 dea1058164a7e8df3aa85d8b05cfe71a
BLAKE2b-256 2d6e6c6c42929d042cb8c1bbd09378e3d52f78e6b135e7dd8ba339efbb07a084

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 44c0df6b9c6b786ddfd1cf45f216563d195083245ab9e6d3a1885d74b0434acc
MD5 4724a90a062995b049f7d4a9317ff30b
BLAKE2b-256 85562d1a62c4c53036eb027d13efeb47ec89d1df20b23a2f76174f6648cfae26

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