module `sphinxext.sphinx_quote_extension`¶

Short summary¶

module pyquickhelper.sphinxext.sphinx_quote_extension

Defines a sphinx extension for a quote.

Classes¶

class	truncated documentation
`quote_node`	Defines `quote` node.
`QuoteNode`	A `quotedef` entry, displayed in the form of an admonition. It takes the following options:

Functions¶

function	truncated documentation
`depart_quote_node`	depart_quote_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py
`depart_quote_node_rst`	depart_quote_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py
`setup`	setup for `mathdef` (sphinx)
`visit_quote_node`	visit_quote_node
`visit_quote_node_rst`	visit_quote_node

Methods¶

method	truncated documentation
`run`	Builds the mathdef text.

Documentation¶

Defines a sphinx extension for a quote.

source on GitHub

class pyquickhelper.sphinxext.sphinx_quote_extension.QuoteNode(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

Bases: docutils.parsers.rst.directives.admonitions.BaseAdmonition

A quotedef entry, displayed in the form of an admonition. It takes the following options:

author
book
year
pages
tag
source
lid or label
index, additional index words beside the title and the author
date, if the text was written or declared at specific date

Example:

.. quote::
    :author: author
    :book: book
    :year: year
    :pages: pages (optional)
    :tag: something
    :lid: id (used for further reference)
    :source: optional
    :index: word

    A monkey could...