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. |
Functions¶
function |
truncated documentation |
---|---|
Initializes the doctree builder. |
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.
- class pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder(*args, **kwargs)[source]¶
Bases:
Builder
Defines a doctree builder.
Constructor, add a logger.
- default_translator_class[source]¶
alias of
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(document, builder)[source]¶
Bases:
NodeVisitor
,CommonSphinxWriterHelpers
Defines a translator for doctree
- class pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeWriter(builder)[source]¶
Bases:
Writer
Defines a doctree writer.
- output = None[source]¶
Final translated form of document
(str for text, bytes for binary formats); set by translate().
- settings_defaults = {}[source]¶
A dictionary of defaults for settings not in settings_spec (internal settings, intended to be inaccessible by command-line and config file). Override in subclasses.
- settings_spec = ('No options here.', '', ())[source]¶
Runtime settings specification. Override in subclasses.
Defines runtime settings and associated command-line options, as used by docutils.frontend.OptionParser. This is a tuple of:
Option group title (string or None which implies no group, just a list of single options).
Description (string or None).
A sequence of option tuples. Each consists of:
Help text (string)
List of option strings (e.g.
['-Q', '--quux']
).Dictionary of keyword arguments sent to the OptionParser/OptionGroup
add_option
method.Runtime setting names are derived implicitly from long option names (’–a-setting’ becomes
settings.a_setting
) or explicitly from the ‘dest’ keyword argument.Most settings will also have a ‘validator’ keyword & function. The validator function validates setting values (from configuration files and command-line option arguments) and converts them to appropriate types. For example, the
docutils.frontend.validate_boolean
function, required by all boolean settings, converts true values (‘1’, ‘on’, ‘yes’, and ‘true’) to 1 and false values (‘0’, ‘off’, ‘no’, ‘false’, and ‘’) to 0. Validators need only be set once per setting. See the docutils.frontend.validate_* functions.See the optparse docs for more details.
More triples of group title, description, options, as many times as needed. Thus, settings_spec tuples can be simply concatenated.
- 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
DocTreeTranslator