Sphinx-Gallery
0.11.1
Versions v: stable
Versions
dev
stable

Using Sphinx Gallery

  • Getting Started with Sphinx-Gallery
  • How to structure your Python scripts for Sphinx-Gallery
  • Configuration
  • Who uses Sphinx-Gallery

Advanced usage and information

  • Advanced usage
  • Frequently Asked Questions
  • Sphinx-Gallery Utilities
    • Convert Python scripts into Jupyter Notebooks
    • Embedding Sphinx-Gallery inside your documentation script extensions

Example galleries

  • Gallery of Examples
  • Notebook style example
  • Gallery of Examples using Mayavi
  • Gallery of Examples using PyVista

API and developer reference

  • Sphinx-Gallery API Reference
  • Change Log
  • Fork Sphinx-Gallery on Github
Sphinx-Gallery
  • Docs »
  • Sphinx-Gallery Utilities

Sphinx-Gallery Utilities¶

Convert Python scripts into Jupyter Notebooks¶

Sphinx Gallery exposes its python source to Jupyter notebook converter as a executable script too. To use this utility just call the script and give the Python source file as argument:

$ sphx_glr_python_to_jupyter.py python_script.py

Embedding Sphinx-Gallery inside your documentation script extensions¶

If you want to embed Sphinx-Gallery in your project instead of putting it as a dependency you can call our embedding script inside your Sphinx extensions folder:

$ copy_sphinxgallery.sh

This will download directly from PyPI our latest released code and save it to the current folder. This is a stripped version of the Sphinx-Gallery module to incorporate in your project. You should also add it to your version control system.

Previous Next

© Copyright 2014-2022, Sphinx-gallery developers.

Built with Sphinx using a theme provided by Read the Docs.