sphinx_gallery.binder

Binder utility functions

Integration with Binder is on an experimental stage. Note that this API may change in the future.

Warning

Binder is still beta technology, so there may be instability in the experience of users who click Binder links.

Functions

sphinx_gallery.binder.check_binder_conf(binder_conf)

Check to make sure that the Binder configuration is correct.

sphinx_gallery.binder.copy_binder_files(app, exception)

Copy all Binder requirements and notebooks files.

sphinx_gallery.binder.gen_binder_rst(fname, binder_conf, gallery_conf)

Generate the RST + link for the Binder badge.

Parameters:
  • fname (str) – The path to the .py file for which a Binder badge will be generated.
  • binder_conf (dict | None) –

    If a dictionary it must have the following keys:

    ’url’: The URL of the BinderHub instance that’s running a Binder
    service.
    ’org’: The GitHub organization to which the documentation will be
    pushed.
    ’repo’: The GitHub repository to which the documentation will be
    pushed.
    ’branch’: The Git branch on which the documentation exists (e.g.,
    gh-pages).
    ’dependencies’: A list of paths to dependency files that match the
    Binderspec.
Returns:

rst – The reStructuredText for the Binder badge that links to this file.

Return type:

str

sphinx_gallery.binder.gen_binder_url(fname, binder_conf, gallery_conf)

Generate a Binder URL according to the configuration in conf.py.

Parameters:
  • fname (str) – The path to the .py file for which a Binder badge will be generated.
  • binder_conf (dict | None) – The Binder configuration dictionary. See gen_binder_rst for details.
Returns:

binder_url – A URL that can be used to direct the user to the live Binder environment.

Return type:

str