module sphinxext._sphinx_common_builder

Inheritance diagram of pyquickhelper.sphinxext._sphinx_common_builder

Short summary

module pyquickhelper.sphinxext._sphinx_common_builder

Common functions for Sphinx writers.

source on GitHub

Classes

class

truncated documentation

CommonSphinxWriterHelpers

Common functions used in RstTranslator and MdTranslator.

Methods

method

truncated documentation

base_visit_image

Processes an image. By default, it writes the image on disk. Inspired from visit_image

hash_md5_readfile

Computes a hash of a file.

Documentation

Common functions for Sphinx writers.

source on GitHub

class pyquickhelper.sphinxext._sphinx_common_builder.CommonSphinxWriterHelpers[source][source]

Bases: object

Common functions used in RstTranslator and MdTranslator.

source on GitHub

base_visit_image(node, image_dest=None)[source][source]

Processes an image. By default, it writes the image on disk. Inspired from visit_image implemented in docutils.

Parameters
  • node – image node

  • image_dest – image destination (location where they will be copied)

Returns

attributes

source on GitHub

hash_md5_readfile(filename)[source][source]

Computes a hash of a file.

Parameters

filename – filename

Returns

string

source on GitHub