module sphinxext.sphinximages.sphinxtrib.images

Inheritance diagram of pyquickhelper.sphinxext.sphinximages.sphinxtrib.images

Short summary

module pyquickhelper.sphinxext.sphinximages.sphinxtrib.images

Sphinx extension for images.

source on GitHub

Classes

class

truncated documentation

gallery_node

sphinx node

image_node

sphinx node

ImageDirective

Directive which overrides default sphinx directive. It’s backward compatibile and it’s adding more cool stuff.

Functions

function

truncated documentation

configure_backend

local function

directive_boolean

local function

download_images

Downloads images before running the documentation.

get_image_extension

Guesses an extension for an image.

install_backend_static_files

local function

setup

setup for sphinx extension

Properties

property

truncated documentation

document

Return the document node at the root of the tree containing this Node.

document

Return the document node at the root of the tree containing this Node.

Methods

method

truncated documentation

align

is_remote

local function

run

Documentation

Sphinx extension for images.

source on GitHub

class pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.ImageDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Bases: Directive

Directive which overrides default sphinx directive. It’s backward compatibile and it’s adding more cool stuff.

source on GitHub

has_content = True[source]

May the directive have content?

is_remote(uri)[source]

local function

option_spec = {'align': <function ImageDirective.align>, 'alt': <function unchanged>, 'class': <function class_option>, 'download': <function directive_boolean>, 'group': <function unchanged>, 'height': <function length_or_unitless>, 'legacy_class': <function class_option>, 'show_caption': <function directive_boolean>, 'strech': <function choice>, 'target': <function unchanged>, 'title': <function unchanged>, 'width': <function length_or_percentage_or_unitless>}[source]

Mapping of option names to validator functions.

required_arguments = True[source]

Number of required directive arguments.

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.configure_backend(app)[source]

local function

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.directive_boolean(value)[source]

local function

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.download_images(app, env)[source]

Downloads images before running the documentation.

Parameters
  • appSphinx application

  • env – environment

source on GitHub

class pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.gallery_node(rawsource='', *children, **attributes)[source]

Bases: image, General, Element

sphinx node

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.get_image_extension(uri)[source]

Guesses an extension for an image.

source on GitHub

class pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.image_node(rawsource='', *children, **attributes)[source]

Bases: image, General, Element

sphinx node

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.install_backend_static_files(app, env)[source]

local function

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.setup(app)[source]

setup for sphinx extension

source on GitHub