module sphinxext.sphinx_doctree_builder

Short summary

module pyquickhelper.sphinxext.sphinx_doctree_builder

Defines a sphinx extension to output sphinx doctree.

Classes

class	truncated documentation
DocTreeBuilder	Defines a doctree builder.
DocTreeTranslator	Defines a translator for doctree
DocTreeWriter	Defines a doctree writer.

Functions

function	truncated documentation
setup	Initializes the doctree builder.

Methods

method	truncated documentation
__init__	Constructor, add a logger.
__init__
__init__
_format_obj
add_text
depart_document
depart_Text
end_state
finish
get_outdated_docs	Return an iterable of input files that are outdated. This method is taken from TextBuilder.get_outdated_docs() …
get_outfilename	Overwrites get_target_uri to control file names.
get_target_uri
handle_page
init	Load necessary templates and perform initialization.
log_unknown
new_state
prepare_writing
translate
unknown_departure
unknown_visit
visit_document
visit_Text
wrap
write_doc

Documentation

Defines a sphinx extension to output sphinx doctree.

New in version 1.8.

source on GitHub

class pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder(*args, **kwargs)

Bases: sphinx.builders.Builder

Defines a doctree builder.

source on GitHub

Constructor, add a logger.

source on GitHub

__init__(*args, **kwargs)

Constructor, add a logger.

source on GitHub

default_translator_class

alias of pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator

finish()

Finish the building process.

The default implementation does nothing.

get_outdated_docs()

Return an iterable of input files that are outdated. This method is taken from TextBuilder.get_outdated_docs() with minor changes to support (confval, doctree_file_transform)).

source on GitHub

get_outfilename(pagename)

Overwrites get_target_uri to control file names.

source on GitHub

get_target_uri(docname, typ=None)

Return the target URI for a document name.

typ can be used to qualify the link characteristic for individual builders.

init()

Load necessary templates and perform initialization.

source on GitHub

prepare_writing(docnames)

A place where you can add logic before write_doc() is run

write_doc(docname, doctree)

Where you actually write something to the filesystem.

class pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator(builder, document)

Bases: docutils.nodes.NodeVisitor, pyquickhelper.sphinxext._sphinx_common_builder.CommonSphinxWriterHelpers

Defines a translator for doctree

source on GitHub

__init__(builder, document)

Initialize self. See help(type(self)) for accurate signature.

_format_obj(obj)

unknown_departure(node)

Called before exiting unknown Node types.

Raise exception unless overridden.

unknown_visit(node)

Called when entering unknown Node types.

Raise an exception unless overridden.

class pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeWriter(builder)

Bases: docutils.writers.Writer

Defines a doctree writer.

source on GitHub

__init__(builder)

Initialize self. See help(type(self)) for accurate signature.

translate()

Do final translation of self.document into self.output. Called from write. Override in subclasses.

Usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node_class_names) and possibly non-standard elements used by the current Reader as well.

translator_class

alias of pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator

pyquickhelper.sphinxext.sphinx_doctree_builder.setup(app)

Initializes the doctree builder.

source on GitHub