sphinx.ext.doctest.DocTestBuilder

class documentation

class DocTestBuilder(Builder): (source)

View In Hierarchy

Runs test snippets in the documentation.

Static Method get_line_number Get the real line number or admit we don't know.
Method compile Undocumented
Method finish Finish the building process.
Method get_filename_for_node Try to get the file which actually contains the doctest, not the filename of the document it's included in.
Method get_outdated_docs Return an iterable of output files that are outdated, or a string describing what an update build will build.
Method get_target_uri Return the target URI for a document name.
Method init Load necessary templates and perform initialization. The default implementation does nothing.
Method skipped Undocumented
Method test_doc Undocumented
Method test_group Undocumented
Method write Undocumented
Class Variable epilog Undocumented
Class Variable name Undocumented
Instance Variable cleanup_failures Undocumented
Instance Variable cleanup_runner Undocumented
Instance Variable cleanup_tries Undocumented
Instance Variable opt Undocumented
Instance Variable outfile Undocumented
Instance Variable setup_failures Undocumented
Instance Variable setup_runner Undocumented
Instance Variable setup_tries Undocumented
Instance Variable test_runner Undocumented
Instance Variable total_failures Undocumented
Instance Variable total_tries Undocumented
Instance Variable type Undocumented
Method _out Undocumented
Method _warn_out Undocumented

Inherited from Builder:

Method __init__ Undocumented
Method build Main build method.
Method build_all Build all source files.
Method build_specific Only rebuild as much as needed for changes in the *filenames*.
Method build_update Only rebuild what was changed or added since last build.
Method cleanup Cleanup any resources.
Method compile_all_catalogs Undocumented
Method compile_catalogs Undocumented
Method compile_specific_catalogs Undocumented
Method compile_update_catalogs Undocumented
Method create_template_bridge Return the template bridge configured.
Method create_translator Return an instance of translator.
Method get_asset_paths Return list of paths for assets (ex. templates, CSS, etc.).
Method get_builder_config Return a builder specific option.
Method get_relative_uri Return a relative URI between two source filenames.
Method get_translator_class Return a class of translator.
Method post_process_images Pick the best candidate for all image URIs.
Method prepare_writing A place where you can add logic before :meth:`write_doc` is run
Method read (Re-)read all files new or changed since last update.
Method read_doc Parse a file and add/update inventory entries for the doctree.
Method set_environment Store BuildEnvironment object.
Method write_doc Where you actually write something to the filesystem.
Method write_doc_serialized Handle parts of write_doc that must be called in the main process if parallel build is active.
Method write_doctree Write the doctree to a file.
Class Variable allow_parallel Undocumented
Class Variable default_translator_class Undocumented
Class Variable format Undocumented
Class Variable supported_data_uri_images Undocumented
Class Variable supported_image_types Undocumented
Class Variable supported_remote_images Undocumented
Class Variable use_message_catalog Undocumented
Class Variable versioning_compare Undocumented
Class Variable versioning_method Undocumented
Instance Variable app Undocumented
Instance Variable confdir Undocumented
Instance Variable config Undocumented
Instance Variable doctreedir Undocumented
Instance Variable env Undocumented
Instance Variable events Undocumented
Instance Variable finish_tasks Undocumented
Instance Variable imagedir Undocumented
Instance Variable images Undocumented
Instance Variable imgpath Undocumented
Instance Variable outdir Undocumented
Instance Variable parallel_ok Undocumented
Instance Variable srcdir Undocumented
Instance Variable tags Undocumented
Instance Variable templates Undocumented
Method _read_parallel Undocumented
Method _read_serial Undocumented
Method _write_parallel Undocumented
Method _write_serial Undocumented
@staticmethod
def get_line_number(node): (source)

Get the real line number or admit we don't know.

Parameters
node:NodeUndocumented
Returns
int|NoneUndocumented
def compile(self, code, name, type, flags, dont_inherit): (source)

Undocumented

Parameters
code:strUndocumented
name:strUndocumented
type:strUndocumented
flags:AnyUndocumented
dont_inherit:boolUndocumented
Returns
AnyUndocumented
def finish(self): (source)
overrides sphinx.builders.Builder.finish

Finish the building process. The default implementation does nothing.

def get_filename_for_node(self, node, docname): (source)

Try to get the file which actually contains the doctest, not the filename of the document it's included in.

Parameters
node:NodeUndocumented
docname:strUndocumented
Returns
strUndocumented
def get_outdated_docs(self): (source)
overrides sphinx.builders.Builder.get_outdated_docs

Return an iterable of output files that are outdated, or a string describing what an update build will build. If the builder does not output individual files corresponding to source files, return a string here. If it does, return an iterable of those files that need to be written.

Returns
set[str]Undocumented
def get_target_uri(self, docname, typ=None): (source)
overrides sphinx.builders.Builder.get_target_uri

Return the target URI for a document name. *typ* can be used to qualify the link characteristic for individual builders.

Parameters
docname:strUndocumented
typ:str|NoneUndocumented
Returns
strUndocumented
def init(self): (source)
overrides sphinx.builders.Builder.init

Load necessary templates and perform initialization. The default implementation does nothing.

def skipped(self, node): (source)

Undocumented

Parameters
node:ElementUndocumented
Returns
boolUndocumented
def test_doc(self, docname, doctree): (source)

Undocumented

Parameters
docname:strUndocumented
doctree:NodeUndocumented
def test_group(self, group): (source)

Undocumented

Parameters
group:TestGroupUndocumented
def write(self, build_docnames, updated_docnames, method='update'): (source)
overrides sphinx.builders.Builder.write

Undocumented

Parameters
build_docnames:Iterable[str]Undocumented
updated_docnames:Sequence[str]Undocumented
method:strUndocumented
epilog = (source)
overrides sphinx.builders.Builder.epilog

Undocumented

name: str = (source)
overrides sphinx.builders.Builder.name

Undocumented

cleanup_failures: int = (source)

Undocumented

cleanup_runner = (source)

Undocumented

cleanup_tries: int = (source)

Undocumented

opt = (source)

Undocumented

outfile = (source)

Undocumented

setup_failures: int = (source)

Undocumented

setup_runner = (source)

Undocumented

setup_tries: int = (source)

Undocumented

test_runner = (source)

Undocumented

total_failures: int = (source)

Undocumented

total_tries: int = (source)

Undocumented

type: str = (source)

Undocumented

def _out(self, text): (source)

Undocumented

Parameters
text:strUndocumented
def _warn_out(self, text): (source)

Undocumented

Parameters
text:strUndocumented