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

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

default_translator_class

CustomSingleFileHTMLBuilder

docname

_CustomBuildEnvironment

Returns the docname of the document currently being parsed.

document

revealjs

Return the document node at the root of the tree containing this Node.

document

rv_code

Return the document node at the root of the tree containing this Node.

document

rv_note

Return the document node at the root of the tree containing this Node.

document

rv_small

Return the document node at the root of the tree containing this Node.

document

autosignature_node

Return the document node at the root of the tree containing this Node.

document

bigger_node

Return the document node at the root of the tree containing this Node.

document

blocref_node

Return the document node at the root of the tree containing this Node.

document

blocreflist

Return the document node at the root of the tree containing this Node.

document

blogpost_node

Return the document node at the root of the tree containing this Node.

document

blogpostagg_node

Return the document node at the root of the tree containing this Node.

document

blogpostlist_node

Return the document node at the root of the tree containing this Node.

document

cmdref_node

Return the document node at the root of the tree containing this Node.

document

cmdreflist

Return the document node at the root of the tree containing this Node.

document

collapse_node

Return the document node at the root of the tree containing this Node.

document

downloadlink_node

Return the document node at the root of the tree containing this Node.

document

epkg_node

Return the document node at the root of the tree containing this Node.

document

exref_node

Return the document node at the root of the tree containing this Node.

document

exreflist

Return the document node at the root of the tree containing this Node.

document

faqref_node

Return the document node at the root of the tree containing this Node.

document

faqreflist

Return the document node at the root of the tree containing this Node.

document

gdot_node

Return the document node at the root of the tree containing this Node.

document

githublink_node

Return the document node at the root of the tree containing this Node.

document

gitlog_node

Return the document node at the root of the tree containing this Node.

document

simpleimage_node

Return the document node at the root of the tree containing this Node.

document

mathdef_node

Return the document node at the root of the tree containing this Node.

document

mathdeflist

Return the document node at the root of the tree containing this Node.

document

nbref_node

Return the document node at the root of the tree containing this Node.

document

nbreflist

Return the document node at the root of the tree containing this Node.

document

postcontents_node

Return the document node at the root of the tree containing this Node.

document

quote_node

Return the document node at the root of the tree containing this Node.

document

runpython_node

Return the document node at the root of the tree containing this Node.

document

sharenet_node

Return the document node at the root of the tree containing this Node.

document

tpl_node

Return the document node at the root of the tree containing this Node.

document

tocdelay_node

Return the document node at the root of the tree containing this Node.

document

todoext_node

Return the document node at the root of the tree containing this Node.

document

todoextlist

Return the document node at the root of the tree containing this Node.

document

video_node

Return the document node at the root of the tree containing this Node.

document

youtube_node

Return the document node at the root of the tree containing this Node.

document

gallery_node

Return the document node at the root of the tree containing this Node.

document

image_node

Return the document node at the root of the tree containing this Node.

env

CustomTocTree

Reference to the BuildEnvironment object.

environment

UpgradedRSTExporter

extensions

MockSphinxApp

filename

CustomLog

returns _filename

found_docs

_CustomBuildEnvironment

contains all existing docnames.

fullname

FileTreeNode

Returns the full name.

fullpath

CustomLog

returns _fullpath

html_themes

_CustomSphinx

html_themes

CustomSphinxApp

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() …

key

ModuleMemberDoc

Returns a key to identify it.

math_renderer_name

CustomSingleFileHTMLBuilder

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. …

native_id

_AsyncLineReader

Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. …

native_id

DocumentationThreadServer

Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. …

permalink_text

HTMLTranslatorWithCustomDirectives

prop

_Types

root

FileTreeNode

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

size

FileTreeNode

Returns the size.

table

LatexTranslatorWithCustomDirectives

Get current table.

table

EnhancedLaTeXTranslator

Get current table.

template

UpgradedRSTExporter

truncdoc

IndexInformation

Returns self.text.

type

FileTreeNode

Returns the file type (file or folder).

usepackages

MemoryLatexBuilder

usepackages

EnhancedLaTeXBuilder

usepackages_after_hyperref

MemoryLatexBuilder

usepackages_after_hyperref

EnhancedLaTeXBuilder