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 |
---|---|
Defines a doctree builder. |
|
Defines a translator for doctree |
|
Defines a doctree writer. |
Methods¶
method |
truncated documentation |
---|---|
Constructor, add a logger. |
|
|
|
|
|
|
|
|
|
Return an iterable of input files that are outdated. This method is taken from |
|
Overwrites get_target_uri to control file names. |
|
|
|
Load necessary templates and perform initialization. |
|
|
|
|
|
|
|
|
|
|
|
Documentation¶
Defines a sphinx extension to output sphinx doctree.
New in version 1.8.
-
class
pyquickhelper.sphinxext.sphinx_doctree_builder.
DocTreeBuilder
(*args, **kwargs)[source]¶ Bases:
sphinx.builders.Builder
Defines a doctree builder.
Constructor, add a logger.
-
default_translator_class
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator
-
get_outdated_docs
()[source]¶ 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))
.
-
get_target_uri
(docname, typ=None)[source]¶ Return the target URI for a document name.
typ can be used to qualify the link characteristic for individual builders.
-
prepare_writing
(docnames)[source]¶ A place where you can add logic before
write_doc()
is run
-
-
class
pyquickhelper.sphinxext.sphinx_doctree_builder.
DocTreeTranslator
(builder, document)[source]¶ Bases:
docutils.nodes.NodeVisitor
,pyquickhelper.sphinxext._sphinx_common_builder.CommonSphinxWriterHelpers
Defines a translator for doctree
-
class
pyquickhelper.sphinxext.sphinx_doctree_builder.
DocTreeWriter
(builder)[source]¶ Bases:
docutils.writers.Writer
Defines a doctree writer.
-
translate
()[source]¶ 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
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator
-