a `mkdocs` plugin to generate example galleries from python scripts, similar to `sphinx-gallery`.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for smarie from gravatar.com smarie

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD 3-Clause)
  • Author: Sylvain MARIE <sylvain.marie@se.com>
  • Tags gallery, web, page, generator, figure, jupyter, notebook, binder, example, code, latex, mkdocs, sphinx
Classifiers

Project description

mkdocs-gallery

Sphinx-Gallery features for mkdocs (no Sphinx dependency !).

Python versions Build Status Tests Status Coverage Status codecov Flake8 Status

Documentation PyPI Downloads Downloads per week GitHub stars DOI

Do you love Sphinx-Gallery but prefer mkdocs over Sphinx for your documentation ? mkdocs-gallery was written for you ;)

It relies on mkdocs-material to get the most of mkdocs, so that your galleries look nice!

The documentation for users is available here: https://smarie.github.io/mkdocs-gallery/

A readme for developers is available here: https://github.com/smarie/mkdocs-gallery

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page