BSD Ports

textproc/py-sphinx-gallery 0.19.0 DragonFly

Sphinx extension that builds an HTML gallery of examples from any set of Python scripts

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
BSD3CLAUSE
Categories
python, textproc
Package size
563.6 KiB, 2127.7 KiB installed

Description

Sphinx-Gallery is a Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.

Features:

  • Create example galleries automatically by running pure Python example scripts while capturing outputs + figures, rendering them into reST files built into your documentation by Sphinx
  • Embed reST in your example Python files, allowing you to interweave narrative-like content with code that generates plots in your documentation. Sphinx-Gallery also automatically generates a Jupyter Notebook for each your example page.
  • Add mini-galleries for API documentation. Sphinx-Gallery can generate mini-galleries listing all examples that use a particular function/method/etc.
  • Add intersphinx links to your examples. Sphinx-Gallery can automatically add links to API documentation for functions/methods/classes that are used in your examples (for any Python module that uses intersphinx).
  • Manage multiple galleries to create and embed galleries for several folders of examples.

In the other systems

SystemPortVersion
DragonFlytextproc/py-sphinx-gallery0.19.0
FreeBSDtextproc/py-sphinx-gallery0.22.1
NetBSDtextproc/py-sphinx-gallery0.21.0
HardenedBSDtextproc/py-sphinx-gallery0.22.1
GhostBSDtextproc/py-sphinx-gallery0.22.1

Install

Binary package:

pkg install py311-sphinx-gallery

From DPorts:

cd /usr/dports/textproc/py-sphinx-gallery && make install clean

Dependencies

Run dependencies 3

No port depends on this one.