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

Properties¶

property	truncated documentation
`document`	Return the document root node of the tree containing this 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: BaseAdmonition

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

author
book or manga or film or show or disc or comic or child or ado
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
title1, by default, the author comes first, if True, the title is

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...

source on GitHub

final_argument_whitespace = False[source]¶: May the final argument contain whitespace?

has_content = True[source]¶: May the directive have content?

node_class[source]¶: alias of quote_node

option_spec = {'ado': <function unchanged>, 'author': <function unchanged>, 'book': <function unchanged>, 'child': <function unchanged>, 'class': <function class_option>, 'comic': <function unchanged>, 'date': <function unchanged>, 'disc': <function unchanged>, 'film': <function unchanged>, 'index': <function unchanged>, 'label': <function unchanged>, 'lid': <function unchanged>, 'manga': <function unchanged>, 'pages': <function unchanged>, 'show': <function unchanged>, 'source': <function unchanged>, 'tag': <function unchanged>, 'title1': <function unchanged>, 'year': <function unchanged>}[source]¶: Mapping of option names to validator functions.