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.30.tar.gz (19.9 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.30-py3-none-any.whl (616.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: munchboka_edutools-0.1.30.tar.gz
  • Upload date:
  • Size: 19.9 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.30.tar.gz
Algorithm Hash digest
SHA256 cc74c6cd6988c0587aff3cf36e12cb4dd36a91b95270074332f439688d94af13
MD5 6ed7bf0efabed6c975923303627089a0
BLAKE2b-256 bac9504b62069b263860929ccabc5606b972cf29cf5cc8bd402319a12d264bd5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for munchboka_edutools-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 2eca2fe0f20943302c93aabcf6afccc64cc50071aba0ab8159e8ac04e4cb7c82
MD5 217699cc3ae81ca24ed0919dbc373666
BLAKE2b-256 d50eb7d4639ab537c14fd8b812faa72cc84f84d37f2b7cfdaa77b2b1d097c146

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