# mkdocs-gallery
*[Sphinx-Gallery](https://sphinx-gallery.github.io/) features for [mkdocs](https://www.mkdocs.org/) (no [Sphinx](sphinx-doc.org/) dependency !).*
[](https://pypi.python.org/pypi/mkdocs-gallery/) [](https://github.com/smarie/mkdocs-gallery/actions/workflows/base.yml) [](https://smarie.github.io/mkdocs-gallery/reports/junit/report.html) [](https://smarie.github.io/mkdocs-gallery/reports/coverage/index.html) [](https://codecov.io/gh/smarie/mkdocs-gallery) [](https://smarie.github.io/mkdocs-gallery/reports/flake8/index.html)
[](https://smarie.github.io/mkdocs-gallery/) [](https://pypi.python.org/pypi/mkdocs-gallery/) [](https://pepy.tech/project/mkdocs-gallery) [](https://pepy.tech/project/mkdocs-gallery) [](https://github.com/smarie/mkdocs-gallery/stargazers) [](https://doi.org/10.5281/zenodo.5786851)
Do you love [Sphinx-Gallery](https://sphinx-gallery.github.io/) but prefer [mkdocs](https://www.mkdocs.org/) over [Sphinx](sphinx-doc.org/) for your documentation ? `mkdocs-gallery` was written for you ;)
It relies on [mkdocs-material](https://squidfunk.github.io/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/](https://smarie.github.io/mkdocs-gallery/)
A readme for developers is available here: [https://github.com/smarie/mkdocs-gallery](https://github.com/smarie/mkdocs-gallery)
Raw data
{
"_id": null,
"home_page": "https://github.com/smarie/mkdocs-gallery",
"name": "mkdocs-gallery",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "gallery web page generator figure jupyter notebook binder example code latex mkdocs sphinx",
"author": "Sylvain MARIE <sylvain.marie@se.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/0e/0d/cff52859f6864580963ac2a3448a2b4a236f3ff064972f663b04bf107339/mkdocs-gallery-0.10.1.tar.gz",
"platform": null,
"description": "# mkdocs-gallery\n\n*[Sphinx-Gallery](https://sphinx-gallery.github.io/) features for [mkdocs](https://www.mkdocs.org/) (no [Sphinx](sphinx-doc.org/) dependency !).*\n\n[](https://pypi.python.org/pypi/mkdocs-gallery/) [](https://github.com/smarie/mkdocs-gallery/actions/workflows/base.yml) [](https://smarie.github.io/mkdocs-gallery/reports/junit/report.html) [](https://smarie.github.io/mkdocs-gallery/reports/coverage/index.html) [](https://codecov.io/gh/smarie/mkdocs-gallery) [](https://smarie.github.io/mkdocs-gallery/reports/flake8/index.html)\n\n[](https://smarie.github.io/mkdocs-gallery/) [](https://pypi.python.org/pypi/mkdocs-gallery/) [](https://pepy.tech/project/mkdocs-gallery) [](https://pepy.tech/project/mkdocs-gallery) [](https://github.com/smarie/mkdocs-gallery/stargazers) [](https://doi.org/10.5281/zenodo.5786851)\n\nDo you love [Sphinx-Gallery](https://sphinx-gallery.github.io/) but prefer [mkdocs](https://www.mkdocs.org/) over [Sphinx](sphinx-doc.org/) for your documentation ? `mkdocs-gallery` was written for you ;) \n\nIt relies on [mkdocs-material](https://squidfunk.github.io/mkdocs-material) to get the most of mkdocs, so that your galleries look nice!\n\nThe documentation for users is available here: [https://smarie.github.io/mkdocs-gallery/](https://smarie.github.io/mkdocs-gallery/)\n\nA readme for developers is available here: [https://github.com/smarie/mkdocs-gallery](https://github.com/smarie/mkdocs-gallery)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "a `mkdocs` plugin to generate example galleries from python scripts, similar to `sphinx-gallery`.",
"version": "0.10.1",
"project_urls": {
"Download": "https://github.com/smarie/mkdocs-gallery/tarball/0.10.1",
"Homepage": "https://github.com/smarie/mkdocs-gallery"
},
"split_keywords": [
"gallery",
"web",
"page",
"generator",
"figure",
"jupyter",
"notebook",
"binder",
"example",
"code",
"latex",
"mkdocs",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61ff354c726a240f25515561626cfbd57aa714bad0fbaf5e8f64dbb2a5dfd49c",
"md5": "f08677d41828dfef1a49a0281ed7499b",
"sha256": "0a4c35d286c0263b84700e54bebc63f39b00a998911f126beb647a64c51163ef"
},
"downloads": -1,
"filename": "mkdocs_gallery-0.10.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f08677d41828dfef1a49a0281ed7499b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 137544,
"upload_time": "2024-03-15T16:49:01",
"upload_time_iso_8601": "2024-03-15T16:49:01.512654Z",
"url": "https://files.pythonhosted.org/packages/61/ff/354c726a240f25515561626cfbd57aa714bad0fbaf5e8f64dbb2a5dfd49c/mkdocs_gallery-0.10.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e0dcff52859f6864580963ac2a3448a2b4a236f3ff064972f663b04bf107339",
"md5": "ba555343cc916020190d1d8ee7c3126a",
"sha256": "0090dfdbddd72f7caf8e99819083aabe881b35968dc15b709bea35a073ff45de"
},
"downloads": -1,
"filename": "mkdocs-gallery-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "ba555343cc916020190d1d8ee7c3126a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 427297,
"upload_time": "2024-03-15T16:49:03",
"upload_time_iso_8601": "2024-03-15T16:49:03.477838Z",
"url": "https://files.pythonhosted.org/packages/0e/0d/cff52859f6864580963ac2a3448a2b4a236f3ff064972f663b04bf107339/mkdocs-gallery-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 16:49:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smarie",
"github_project": "mkdocs-gallery",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-gallery"
}
JSON
