Properties

Summary

property

class parent

truncated documentation

Appendix

BenchMark

Returns the metrics.

Appendix

GridBenchMark

Returns the metrics.

Author

BlogPost

Returns the author or None if not defined.

BlogBackground

BlogPost

Returns the blog background or None if not defined.

Categories

BlogPost

Returns the categories.

Content

BlogPost

Returns the content of the blogpost.

Context

MagicClassWithHelpers

return the context or None

Context

MagicCompress

return the context or None

Context

MagicCrypt

return the context or None

Context

MagicDiff

return the context or None

Context

MagicClassExample

return the context or None

Date

BlogPost

Returns the date.

Engines

JenkinsExt

Fields

BlogPost

Returns the fields as a dictionary.

FileName

BlogPost

Returns the filename.

Graphs

BenchMark

Returns images of graphs.

Graphs

GridBenchMark

Returns images of graphs.

Keywords

BlogPost

Returns the keywords.

Lang

BlogPostList

Returns the language.

Mapping

EncryptedBackup

returns the mapping

Metadata

BenchMark

Returns the metrics.

Metadata

GridBenchMark

Returns the metrics.

Metrics

BenchMark

Returns the metrics.

Metrics

GridBenchMark

Returns the metrics.

Name

BenchMark

Returns the name of the benchmark.

Name

GridBenchMark

Returns the name of the benchmark.

Site

MockTransferFTP

return the website

Site

TransferFTP

return the website

Site

MockTransferFTP

return the website

Tag

BlogPost

Produces a tag for the blog post.

Title

BlogPost

Returns the title.

Year

BlogPost

Returns the year, we assume self.date is a string like YYYY-MM-DD.

_

AutoCompletion

return the value

_

AutoCompletionFile

return the value

_members

AutoCompletion

returns all the members

_members

AutoCompletionFile

returns all the members

_nitpick_ignore

_CustomBuildEnvironment

_setting_up_extension

_CustomSphinx

_setting_up_extension

CustomSphinxApp

bibitems

LatexTranslatorWithCustomDirectives

bibitems

EnhancedLaTeXTranslator

classname

ModuleMemberDoc

Returns the class name if the object is a method.

comment

WinZipFile

The comment text associated with the ZIP file.

config

CustomTocTree

Reference to the Config object.

cross_validation_lock

LatexRawOutputPreprocessor

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

cross_validation_lock

UpgradedRSTExporter

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

cross_validation_lock

MagicClassWithHelpers

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

cross_validation_lock

MagicCompress

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

cross_validation_lock

MagicCrypt

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

cross_validation_lock

MagicDiff

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

cross_validation_lock

MagicClassExample

A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

daemon

_AsyncLineReader

A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise …

daemon

DocumentationThreadServer

A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise …

date

FileTreeNode

Returns the modification date.

default_config

UpgradedRSTExporter

docname

_CustomBuildEnvironment

Returns the docname of the document currently being parsed.

enumerable_nodes

_CustomSphinx

enumerable_nodes

CustomSphinxApp

env

CustomTocTree

Reference to the BuildEnvironment object.

environment

UpgradedRSTExporter

extensions

MockSphinxApp

filename

CustomLog

returns _filename

footnotestack

LatexTranslatorWithCustomDirectives

footnotestack

EnhancedLaTeXTranslator

found_docs

_CustomBuildEnvironment

contains all existing docnames.

fullname

FileTreeNode

Returns the full name.

fullpath

CustomLog

returns _fullpath

highlightlang

HTMLTranslatorWithCustomDirectives

highlightlang_base

HTMLTranslatorWithCustomDirectives

highlightlinenothreshold

HTMLTranslatorWithCustomDirectives

highlightopts

HTMLTranslatorWithCustomDirectives

hlsettingstack

LatexTranslatorWithCustomDirectives

hlsettingstack

EnhancedLaTeXTranslator

ident

_AsyncLineReader

Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() …

ident

DocumentationThreadServer

Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() …

in_container_literal_block

LatexTranslatorWithCustomDirectives

in_container_literal_block

EnhancedLaTeXTranslator

key

ModuleMemberDoc

Returns a key to identify it.

math_renderer_name

MemoryHTMLBuilder

name

FileTreeNode

Returns the file name from the root.

name

_AsyncLineReader

A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. …

name

DocumentationThreadServer

A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. …

next_hyperlink_ids

LatexTranslatorWithCustomDirectives

next_hyperlink_ids

EnhancedLaTeXTranslator

next_section_ids

LatexTranslatorWithCustomDirectives

next_section_ids

EnhancedLaTeXTranslator

prop

_Types

root

FileTreeNode

Returns the root directory, the one used as a root for a synchronization.

size

FileTreeNode

Returns the size.

template

UpgradedRSTExporter

truncdoc

IndexInformation

Returns self.text.

type

FileTreeNode

Returns the file type (file or folder).

versionchanges

_CustomBuildEnvironment