sphinx-gallery


Namesphinx-gallery JSON
Version 0.15.0 PyPI version JSON
download
home_pagehttps://sphinx-gallery.github.io
SummaryA `Sphinx <https://www.sphinx-doc.org/en/master/>`_ extension that builds an HTML gallery of examples from any set of Python scripts.
upload_time2023-11-21 03:20:32
maintainer
docs_urlhttps://pythonhosted.org/sphinx-gallery/
authorÓscar Nájera
requires_python>=3.8
license3-clause BSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==============
Sphinx-Gallery
==============

.. image:: https://img.shields.io/pypi/v/sphinx-gallery
    :target: https://pypi.org/project/sphinx-gallery/
    :alt: PyPI

.. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-gallery
    :target: https://anaconda.org/conda-forge/sphinx-gallery
    :alt: Conda-forge

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3741780.svg
    :target: https://doi.org/10.5281/zenodo.3741780
    :alt: Zenodo DOI

.. image:: https://dev.azure.com/sphinx-gallery/sphinx-gallery/_apis/build/status/sphinx-gallery.sphinx-gallery?branchName=master
    :target: https://dev.azure.com/sphinx-gallery/sphinx-gallery/_build/latest?definitionId=1&branchName=master
    :alt: Azure CI status

.. image:: https://circleci.com/gh/sphinx-gallery/sphinx-gallery.svg?style=shield
    :target: https://circleci.com/gh/sphinx-gallery/sphinx-gallery
    :alt: CircleCI status

.. image:: https://codecov.io/github/sphinx-gallery/sphinx-gallery/badge.svg?branch=master&service=github(
    :target: https://app.codecov.io/github/sphinx-gallery/sphinx-gallery
    :alt: Code coverage


.. tagline-begin-content

A `Sphinx <https://www.sphinx-doc.org/en/master/>`_ extension that builds an
HTML gallery of examples from any set of Python scripts.

.. tagline-end-content

.. image:: doc/_static/demo.png
   :width: 80%
   :alt: A demo of a gallery generated by Sphinx-Gallery

Who uses Sphinx-Gallery
=======================

An incomplete list:

.. projects_list_start

* `Apache TVM <https://tvm.apache.org/docs/tutorial/index.html>`_
* `Astropy <https://docs.astropy.org/en/stable/generated/examples/index.html>`_
* `auto-sklearn <https://automl.github.io/auto-sklearn/master/examples/index.html>`_
* `Biotite <https://www.biotite-python.org/examples/gallery/index.html>`_
* `Cartopy <https://scitools.org.uk/cartopy/docs/latest/gallery/>`_
* `FURY <https://fury.gl/latest/auto_examples/index.html>`_
* `pyGIMLi <https://www.pygimli.org/_examples_auto/index.html>`_
* `Matplotlib <https://matplotlib.org/stable/index.html>`_
* `MNE-Python <https://mne.tools/stable/auto_examples/index.html>`_
* `Nestle <http://kylebarbary.com/nestle/examples/index.html>`_
* `NetworkX <https://networkx.org/documentation/stable/auto_examples/index.html>`_
* `Neuraxle <https://www.neuraxle.org/stable/examples/index.html>`_
* `Nilearn <https://nilearn.github.io/stable/auto_examples/index.html>`_
* `OpenML <https://openml.github.io/openml-python/main/examples/index.html>`_
* `OpenTURNS <https://openturns.github.io/openturns/latest/examples/examples.html>`_
* `Optuna <https://optuna.readthedocs.io/en/stable/tutorial/index.html>`_
* `PlasmaPy <https://docs.plasmapy.org/en/latest/examples.html>`_
* `PyGMT <https://www.pygmt.org/latest/gallery/index.html>`_
* `pyRiemann <https://pyriemann.readthedocs.io/en/latest/index.html>`_
* `PyStruct <https://pystruct.github.io/auto_examples/index.html>`_
* `PySurfer <https://pysurfer.github.io/>`_
* `PyTorch tutorials <https://pytorch.org/tutorials>`_
* `PyVista <https://docs.pyvista.org/examples/>`_
* `RADIS <https://radis.readthedocs.io/en/latest/auto_examples/index.html>`_
* `scikit-image <https://scikit-image.org/docs/dev/auto_examples/>`_
* `scikit-learn <https://scikit-learn.org/stable/auto_examples/index.html>`_
* `SimPEG <https://docs.simpeg.xyz/content/examples/>`_
* `Sphinx-Gallery <https://sphinx-gallery.github.io/stable/auto_examples/index.html>`_
* `SunPy <https://docs.sunpy.org/en/stable/generated/gallery/index.html>`_
* `Tonic <https://tonic.readthedocs.io/en/latest/auto_examples/index.html>`_
* `TorchIO <https://torchio.readthedocs.io/auto_examples/index.html>`_

.. projects_list_end

Installation
============

Install via ``pip``
-------------------

.. installation-begin-content

You can do a direct install via ``pip`` by using:

.. code-block:: bash

    $ pip install sphinx-gallery

Sphinx-Gallery will not manage its dependencies when installing, thus
you are required to install them manually. Our minimal dependencies
are **Sphinx >= 4** and Pillow, which we use for scaling images.

Sphinx-Gallery has also support for scraping images from packages like
Matplotlib, Seaborn, and PyVista. We recommend installing system ``optipng``
binaries to reduce the file sizes of the generated PNG files.

.. installation-end-content

Contributing
============

You can get the latest development source from our `Github repository
<https://github.com/sphinx-gallery/sphinx-gallery>`_. You need
``setuptools`` installed in your system to install Sphinx-Gallery. For example,
you can do:

.. code-block:: console

    $ git clone https://github.com/sphinx-gallery/sphinx-gallery
    $ cd sphinx-gallery
    $ pip install -r requirements.txt -r dev-requirements.txt
    $ conda install graphviz  # if using conda, you can get graphviz this way
    $ pip install -e .


Check that you are all set by running:

.. code-block:: console

    $ pytest sphinx_gallery

How to cite
===========

.. citation-begin-content

If you would like to cite Sphinx-Gallery you can do so using our `Zenodo
deposit <https://zenodo.org/record/3741780>`_.

.. citation-end-content

            

Raw data

            {
    "_id": null,
    "home_page": "https://sphinx-gallery.github.io",
    "name": "sphinx-gallery",
    "maintainer": "",
    "docs_url": "https://pythonhosted.org/sphinx-gallery/",
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "\u00d3scar N\u00e1jera",
    "author_email": "najera.oscar@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/aa/22/5bcce07215e1c4b0511b3881b9001c963dad7a639201cdc5746ea39862d5/sphinx-gallery-0.15.0.tar.gz",
    "platform": null,
    "description": "==============\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&branchName=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&service=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 <https://www.sphinx-doc.org/en/master/>`_ extension that builds an\nHTML gallery of examples from any set of Python scripts.\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\nWho uses Sphinx-Gallery\n=======================\n\nAn incomplete list:\n\n.. projects_list_start\n\n* `Apache TVM <https://tvm.apache.org/docs/tutorial/index.html>`_\n* `Astropy <https://docs.astropy.org/en/stable/generated/examples/index.html>`_\n* `auto-sklearn <https://automl.github.io/auto-sklearn/master/examples/index.html>`_\n* `Biotite <https://www.biotite-python.org/examples/gallery/index.html>`_\n* `Cartopy <https://scitools.org.uk/cartopy/docs/latest/gallery/>`_\n* `FURY <https://fury.gl/latest/auto_examples/index.html>`_\n* `pyGIMLi <https://www.pygimli.org/_examples_auto/index.html>`_\n* `Matplotlib <https://matplotlib.org/stable/index.html>`_\n* `MNE-Python <https://mne.tools/stable/auto_examples/index.html>`_\n* `Nestle <http://kylebarbary.com/nestle/examples/index.html>`_\n* `NetworkX <https://networkx.org/documentation/stable/auto_examples/index.html>`_\n* `Neuraxle <https://www.neuraxle.org/stable/examples/index.html>`_\n* `Nilearn <https://nilearn.github.io/stable/auto_examples/index.html>`_\n* `OpenML <https://openml.github.io/openml-python/main/examples/index.html>`_\n* `OpenTURNS <https://openturns.github.io/openturns/latest/examples/examples.html>`_\n* `Optuna <https://optuna.readthedocs.io/en/stable/tutorial/index.html>`_\n* `PlasmaPy <https://docs.plasmapy.org/en/latest/examples.html>`_\n* `PyGMT <https://www.pygmt.org/latest/gallery/index.html>`_\n* `pyRiemann <https://pyriemann.readthedocs.io/en/latest/index.html>`_\n* `PyStruct <https://pystruct.github.io/auto_examples/index.html>`_\n* `PySurfer <https://pysurfer.github.io/>`_\n* `PyTorch tutorials <https://pytorch.org/tutorials>`_\n* `PyVista <https://docs.pyvista.org/examples/>`_\n* `RADIS <https://radis.readthedocs.io/en/latest/auto_examples/index.html>`_\n* `scikit-image <https://scikit-image.org/docs/dev/auto_examples/>`_\n* `scikit-learn <https://scikit-learn.org/stable/auto_examples/index.html>`_\n* `SimPEG <https://docs.simpeg.xyz/content/examples/>`_\n* `Sphinx-Gallery <https://sphinx-gallery.github.io/stable/auto_examples/index.html>`_\n* `SunPy <https://docs.sunpy.org/en/stable/generated/gallery/index.html>`_\n* `Tonic <https://tonic.readthedocs.io/en/latest/auto_examples/index.html>`_\n* `TorchIO <https://torchio.readthedocs.io/auto_examples/index.html>`_\n\n.. projects_list_end\n\nInstallation\n============\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\nSphinx-Gallery will not manage its dependencies when installing, thus\nyou are required to install them manually. Our minimal dependencies\nare **Sphinx >= 4** and Pillow, which we use for scaling images.\n\nSphinx-Gallery has also support for scraping images from packages like\nMatplotlib, Seaborn, and PyVista. We recommend installing system ``optipng``\nbinaries to reduce the file sizes of the generated PNG files.\n\n.. installation-end-content\n\nContributing\n============\n\nYou can get the latest development source from our `Github repository\n<https://github.com/sphinx-gallery/sphinx-gallery>`_. 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    $ pip install -r requirements.txt -r dev-requirements.txt\n    $ conda install graphviz  # if using conda, you can get graphviz this way\n    $ pip install -e .\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 <https://zenodo.org/record/3741780>`_.\n\n.. citation-end-content\n",
    "bugtrack_url": null,
    "license": "3-clause BSD",
    "summary": "A `Sphinx <https://www.sphinx-doc.org/en/master/>`_ extension that builds an HTML gallery of examples from any set of Python scripts.",
    "version": "0.15.0",
    "project_urls": {
        "Documentation": "https://sphinx-gallery.github.io",
        "Homepage": "https://sphinx-gallery.github.io",
        "Source": "https://github.com/sphinx-gallery/sphinx-gallery"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a60bbcb59fd0ee7f59d2f9745594f4b3f8f5011b3e16864322d2edb469cd9872",
                "md5": "836d9c22cac07fcd296f6d9969460505",
                "sha256": "d66d38d901f6b65b6e3ee6c2584e37476b035d9e52907b1593a3f312946ae724"
            },
            "downloads": -1,
            "filename": "sphinx_gallery-0.15.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "836d9c22cac07fcd296f6d9969460505",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 164699,
            "upload_time": "2023-11-21T03:20:30",
            "upload_time_iso_8601": "2023-11-21T03:20:30.376661Z",
            "url": "https://files.pythonhosted.org/packages/a6/0b/bcb59fd0ee7f59d2f9745594f4b3f8f5011b3e16864322d2edb469cd9872/sphinx_gallery-0.15.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aa225bcce07215e1c4b0511b3881b9001c963dad7a639201cdc5746ea39862d5",
                "md5": "f3cd552e0556c818ade28ab36f5743bb",
                "sha256": "7217fe98f8c4cce248db798c48f34183e4cdb277d2381e188182f92a14ec26b7"
            },
            "downloads": -1,
            "filename": "sphinx-gallery-0.15.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f3cd552e0556c818ade28ab36f5743bb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 422363,
            "upload_time": "2023-11-21T03:20:32",
            "upload_time_iso_8601": "2023-11-21T03:20:32.738515Z",
            "url": "https://files.pythonhosted.org/packages/aa/22/5bcce07215e1c4b0511b3881b9001c963dad7a639201cdc5746ea39862d5/sphinx-gallery-0.15.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-21 03:20:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sphinx-gallery",
    "github_project": "sphinx-gallery",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "requirements": [],
    "lcname": "sphinx-gallery"
}
        
Elapsed time: 0.17668s