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

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][source]

Bases: docutils.parsers.rst.Directive

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

source on GitHub

is_remote(uri)[source][source]

local function

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

local function

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

local function

pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.download_images(app, env)[source][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][source]

Bases: docutils.nodes.image, docutils.nodes.General, docutils.nodes.Element

sphinx node

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

Guesses an extension for an image.

source on GitHub

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

Bases: docutils.nodes.image, docutils.nodes.General, docutils.nodes.Element

sphinx node

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

local function

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

setup for sphinx extension

source on GitHub