{"id":32178089,"url":"https://github.com/sphinx-gallery/sphinx-gallery","last_synced_at":"2026-04-24T05:00:56.606Z","repository":{"id":22519747,"uuid":"25860190","full_name":"sphinx-gallery/sphinx-gallery","owner":"sphinx-gallery","description":"Sphinx extension for automatic generation of an example gallery","archived":false,"fork":false,"pushed_at":"2026-04-14T17:29:47.000Z","size":3756,"stargazers_count":451,"open_issues_count":127,"forks_count":212,"subscribers_count":13,"default_branch":"master","last_synced_at":"2026-04-14T19:24:06.327Z","etag":null,"topics":["documentation","examples","gallery","gallery-extension","python","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://sphinx-gallery.github.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-gallery.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-10-28T08:41:46.000Z","updated_at":"2026-04-14T17:29:52.000Z","dependencies_parsed_at":"2023-11-27T02:25:38.108Z","dependency_job_id":"b08e4d99-f6a5-4c83-9806-ed9dbd536516","html_url":"https://github.com/sphinx-gallery/sphinx-gallery","commit_stats":{"total_commits":1431,"total_committers":119,"mean_commits":"12.025210084033613","dds":0.6666666666666667,"last_synced_commit":"40f758994e6b76ea62cb67db547b4b2f39e55549"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"purl":"pkg:github/sphinx-gallery/sphinx-gallery","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-gallery%2Fsphinx-gallery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-gallery%2Fsphinx-gallery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-gallery%2Fsphinx-gallery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-gallery%2Fsphinx-gallery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-gallery","download_url":"https://codeload.github.com/sphinx-gallery/sphinx-gallery/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-gallery%2Fsphinx-gallery/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32027520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"ssl_error","status_checked_at":"2026-04-20T00:17:31.068Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","examples","gallery","gallery-extension","python","sphinx","sphinx-extension"],"created_at":"2025-10-21T20:47:22.218Z","updated_at":"2026-04-24T05:00:56.599Z","avatar_url":"https://github.com/sphinx-gallery.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============\nSphinx-Gallery\n==============\n\n.. image:: https://img.shields.io/pypi/v/sphinx-gallery\n    :target: https://pypi.org/project/sphinx-gallery/\n    :alt: PyPI\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-gallery\n    :target: https://anaconda.org/conda-forge/sphinx-gallery\n    :alt: Conda-forge\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3741780.svg\n    :target: https://doi.org/10.5281/zenodo.3741780\n    :alt: Zenodo DOI\n\n.. image:: https://dev.azure.com/sphinx-gallery/sphinx-gallery/_apis/build/status/sphinx-gallery.sphinx-gallery?branchName=master\n    :target: https://dev.azure.com/sphinx-gallery/sphinx-gallery/_build/latest?definitionId=1\u0026branchName=master\n    :alt: Azure CI status\n\n.. image:: https://circleci.com/gh/sphinx-gallery/sphinx-gallery.svg?style=shield\n    :target: https://circleci.com/gh/sphinx-gallery/sphinx-gallery\n    :alt: CircleCI status\n\n.. image:: https://codecov.io/github/sphinx-gallery/sphinx-gallery/badge.svg?branch=master\u0026service=github(\n    :target: https://app.codecov.io/github/sphinx-gallery/sphinx-gallery\n    :alt: Code coverage\n\n\n.. tagline-begin-content\n\nA `Sphinx \u003chttps://www.sphinx-doc.org/en/master/\u003e`_ extension that builds an\nHTML gallery of examples from any set of Python scripts.\nCheck out the `documentation`_ for introductions on how to use it and more...\n\n.. tagline-end-content\n\n.. image:: doc/_static/demo.png\n   :width: 80%\n   :alt: A demo of a gallery generated by Sphinx-Gallery\n\nQuickstart\n==========\n\nSphinx-Gallery can be used to generate an example gallery from ``.py`` files,\nfor a library,\nas well as a stand-alone web page showcasing examples of a particular\nPython package, module, or class.\n\nLet's get started with a simple example or check out the\n `documentation`_ for introductions on how\n to use it and more...\n\nInstall via ``pip``\n-------------------\n\n.. installation-begin-content\n\nYou can do a direct install via ``pip`` by using:\n\n.. code-block:: bash\n\n    $ pip install sphinx-gallery\n\n.. tip::\n    Sphinx-Gallery also has support for scraping images from Matplotlib\n    and Matplotlib-based packages such as Seaborn.\n    We recommend installing system ``optipng`` binaries to reduce\n    the file sizes of the generated PNG files.\n\n.. installation-end-content\n\nAdd examples to your docs\n-------------------------\n\nLet's assume simple scenario, you have a Python package with a directory structure like this:\n\n.. code-block::\n\n    ├── doc\n    │   ├── conf.py\n    │   ├── index.rst\n    |   ├── make.bat\n    │   └── Makefile\n    ├── my_python_module\n    │   ├── __init__.py\n    │   └── mod.py\n    └── examples\n        ├── plot_example.py\n        └── README.txt (or .rst)\n\nEnable Sphinx-Gallery by adding the following to your ``doc/conf.py``:\n\n.. code-block:: python\n\n    extensions = [\n        ...\n        'sphinx_gallery.gen_gallery',\n    ]\n\n    # path to the examples scripts\n    sphinx_gallery_conf = {\n        'examples_dirs': '../examples',   # path to your example scripts\n        'gallery_dirs': 'auto_examples',  # path to where to save gallery generated output\n    }\n\nFinally just compile your docs as usual.\nSphinx-Gallery will generate reST files, adding execution outputs, and save them in ``auto_examples/``.\nAdd a link to ``auto_examples/index.rst`` to include the gallery in your documentation.\n\nWho uses Sphinx-Gallery\n=======================\n\nAn incomplete list:\n\n.. projects_list_start\n\n* `Apache TVM \u003chttps://tvm.apache.org/docs/tutorial/index.html\u003e`_\n* `Atomistic Cookbook \u003chttps://atomistic-cookbook.org\u003e`_\n* `auto-sklearn \u003chttps://automl.github.io/auto-sklearn/master/examples/index.html\u003e`_\n* `Biotite \u003chttps://www.biotite-python.org/latest/examples/index.html\u003e`_\n* `Cartopy \u003chttps://cartopy.readthedocs.io/stable/gallery/index.html\u003e`_\n* `FURY \u003chttps://fury.gl/latest/auto_examples/index.html\u003e`_\n* `pyGIMLi \u003chttps://www.pygimli.org/_examples_auto/index.html\u003e`_\n* `HyperSpy \u003chttps://hyperspy.org/hyperspy-doc/current/auto_examples/index.html\u003e`_\n* `kikuchipy \u003chttps://kikuchipy.org/en/stable/examples/index.html\u003e`_\n* `Matplotlib \u003chttps://matplotlib.org/stable/gallery/index\u003e`_\n* `MNE-Python \u003chttps://mne.tools/stable/auto_examples/index.html\u003e`_\n* `napari \u003chttps://napari.org/stable/gallery.html\u003e`_\n* `Nestle \u003chttp://kylebarbary.com/nestle/examples/index.html\u003e`_\n* `NetworkX \u003chttps://networkx.org/documentation/stable/auto_examples/index.html\u003e`_\n* `Neuraxle \u003chttps://www.neuraxle.org/stable/examples/index.html\u003e`_\n* `Nilearn \u003chttps://nilearn.github.io/stable/auto_examples/index.html\u003e`_\n* `OpenML \u003chttps://openml.github.io/openml-python/main/examples/index.html\u003e`_\n* `OpenTURNS \u003chttps://openturns.github.io/openturns/latest/examples/examples.html\u003e`_\n* `Optuna \u003chttps://optuna.readthedocs.io/en/stable/tutorial/index.html\u003e`_\n* `PlasmaPy \u003chttps://docs.plasmapy.org/en/latest/examples.html\u003e`_\n* `POT \u003chttps://pythonot.github.io/auto_examples/index.html\u003e`_\n* `PyGMT \u003chttps://www.pygmt.org/latest/gallery/index.html\u003e`_\n* `pyRiemann \u003chttps://pyriemann.readthedocs.io/en/latest/auto_examples/index.html\u003e`_\n* `PyStruct \u003chttps://pystruct.github.io/auto_examples/index.html\u003e`_\n* `PySurfer \u003chttps://pysurfer.github.io/auto_examples/index.html\u003e`_\n* `PyTorch tutorials \u003chttps://pytorch.org/tutorials\u003e`_\n* `PyVista \u003chttps://docs.pyvista.org/examples/\u003e`_\n* `pyxem \u003chttps://www.pyxem.org/en/stable/examples/index.html\u003e`_\n* `RADIS \u003chttps://radis.readthedocs.io/en/latest/auto_examples/index.html\u003e`_\n* `scikit-image \u003chttps://scikit-image.org/docs/dev/auto_examples/\u003e`_\n* `scikit-learn \u003chttps://scikit-learn.org/stable/auto_examples/index.html\u003e`_\n* `SimPEG \u003chttps://docs.simpeg.xyz/content/examples/\u003e`_\n* `SKADA Scikit-adaptation \u003chttps://scikit-adaptation.github.io/auto_examples/index.html\u003e`_\n* `Sphinx-Gallery \u003chttps://sphinx-gallery.github.io/stable/auto_examples/index.html\u003e`_\n* `SunPy \u003chttps://docs.sunpy.org/en/stable/generated/gallery/index.html\u003e`_\n* `Tonic \u003chttps://tonic.readthedocs.io/en/latest/auto_examples/index.html\u003e`_\n* `TorchDR \u003chttps://torchdr.github.io/auto_examples/index.html\u003e`_\n* `TorchIO \u003chttps://torchio.readthedocs.io/auto_examples/index.html\u003e`_\n\n.. projects_list_end\n\nContributing\n============\n\nYou can get the latest development source from our `Github repository\n\u003chttps://github.com/sphinx-gallery/sphinx-gallery\u003e`_. You need\n``setuptools`` installed in your system to install Sphinx-Gallery. For example,\nyou can do:\n\n.. code-block:: console\n\n    $ git clone https://github.com/sphinx-gallery/sphinx-gallery\n    $ cd sphinx-gallery\n    $ conda install graphviz  # if using conda, you can get graphviz this way\n    $ pip install -e .[dev]\n\n\nCheck that you are all set by running:\n\n.. code-block:: console\n\n    $ pytest sphinx_gallery\n\nHow to cite\n===========\n\n.. citation-begin-content\n\nIf you would like to cite Sphinx-Gallery you can do so using our `Zenodo\ndeposit \u003chttps://zenodo.org/record/3741780\u003e`_.\n\n.. _documentation: https://sphinx-gallery.github.io/\n\n.. citation-end-content\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-gallery%2Fsphinx-gallery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-gallery%2Fsphinx-gallery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-gallery%2Fsphinx-gallery/lists"}