Paket: python-sphinx-gallery-doc (0.16.0-1)

extension that builds an HTML gallery of examples from Python scripts (Doc)

Sphinx-Gallery is a Sphinx extension that creates an HTML gallery of examples from any set of Python scripts. It offers several functionalities:

  - Automatic Example Galleries Creation: Run example Python scripts to capture
    output and figures, rendering them into reST files integrated into your
    documentation by Sphinx.
  - Narrative Integration with Code:
    Embed reST in your example Python files, allowing you to interweave
    narrative content with code that generates graphics in documentation.
    Sphinx-Gallery also automatically generates a Jupyter Notebook for each
    example page.
  - Mini Galleries for API Documentation:
    Create mini galleries that list all examples that use a specific function
    /method in the API documentation.
  - Intersphinx Links:
    Add intersphinx links to your examples, which automatically connect to API
    documents for functions/methods/classes used in the examples.
  - Multiple Galleries Management:
    Manage multiple galleries to create and embed galleries of diverse sample
    sets.

This package contains documentation for sphinx-gallery.

This page is also available in the following languages (How to set the default document language):