Welcome to Sphinx-Gallery’s documentation!¶
A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.
It is extracted from the scikit-learn project and aims to be an independent general purpose extension.
The code of the project is on Github: Sphinx-Gallery
- Simple examples that run out of the box are the best way to learn a library
- Pleasing, organized, visual layouts
- Links, searching, backlinks throughout examples and documentation
What does it look like?¶
Here is an example gallery generated from a few Python scripts.
Here we put only the examples of our gallery that use a specific function. This display granularity ready to use within your documentation, not just the gigantic galleries with all the examples together.
Go ahead, click on those thumbnails to go to the examples. Beautifully rendered HTML versions of the original python scripts with, narrating prose from the doctrings and inline comments and plots generated by the scripts.
- Runs Python files and captures outputs + figures. Learn how to Set up your project
- Managing multiple galleries no number limit.
- Automatically hyperlink the code in the gallery to the corresponding function documentation. Linking to documentation
- Automatically links from documented functions to examples using the function. Adding references to examples
- Notebook styled examples: turn your scripts into a full narrative with the Notebook Styled examples syntax
- Getting Started with Sphinx-Gallery
- List of config options
- Managing multiple galleries
- Parsing and executing examples based on matching patterns
- Sorting gallery subsections
- Sorting gallery examples
- Linking to documentation
- Adding references to examples
- Using a custom default thumbnail
- Adding line numbers to examples
- Disabling download button of all scripts
- Choosing the thumbnail image
- Generate Binder links for gallery notebooks (experimental)
- Building without executing examples
- Finding Mayavi figures
- Dealing with failing Gallery example scripts
- Setting gallery thumbnail size
- Minimal reported time
- Frequently Asked Questions
- Sphinx-Gallery Syntax
- Sphinx-Gallery Utilities
- Sphinx-Gallery API Reference
- Gallery of Examples
- Secondary gallery
- Change Log
- Fork sphinx-gallery on Github