Sphinx-Gallery
0.8.2
Versions v: stable
Versions
dev
stable

Using Sphinx Gallery

  • Getting Started with Sphinx-Gallery
  • How to structure your Python scripts for Sphinx-Gallery
  • Configuration
    • List of config options
    • Removing warnings
    • Manage multiple galleries
    • Parsing and executing examples via matching patterns
    • Rerunning stale examples
    • Passing command line arguments to example scripts
    • Sorting gallery subsections
    • Sorting gallery examples
    • Add intersphinx links to your examples
    • Add mini-galleries for API documentation
      • Examples using numpy.exp
      • Auto-documenting your API with links to examples
      • Toggling global variable inspection
      • Stylizing code links using CSS
    • Using a custom default thumbnail
    • Adding line numbers to examples
    • Removing config comments
    • Add your own first and last notebook cell
    • Adding images to notebooks
    • Using pypandoc to convert rST to markdown
    • Using JUnit XML files
    • Setting log level
    • Disabling download button of all scripts
    • Choosing the thumbnail image
    • Providing an image for the thumbnail image
    • Generate Binder links for gallery notebooks (experimental)
    • Building without executing examples
    • Compressing images
    • Image scrapers
    • Resetting modules
    • Dealing with failing Gallery example scripts
      • Abort build on first fail
      • Don’t fail the build on exit
    • Setting gallery thumbnail size
    • Minimal reported time
    • Showing memory consumption
    • Show signature
    • Controlling what output is captured
      • Prevent capture of certain classes
  • Who uses Sphinx-Gallery

Advanced usage and information

  • Advanced usage
  • Frequently Asked Questions
  • Sphinx-Gallery Utilities

Example galleries