Skip to main content

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-gallery-0.9.0.tar.gz (424.4 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_gallery-0.9.0-py2.py3-none-any.whl (136.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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