Classes

Summary

class

class parent

truncated documentation

AutoCompletion

You can add auto completion object to IPython by adding member to an instance of this class. All members must begin …

AutoCompletionFile

builds a tree based on a list of files, the class adds A__ before every folder or file starting with _

AutoSignatureDirective

This directive displays a shorter signature than sphinx.ext.autodoc. Available options:

Backend

Backend API for sphinx directive image.

BenchMark

Class to help benchmarking. You should overwrite method init, bench, end, graphs.

BlocRef

A blocref entry, displayed in the form of an admonition. It takes the following options:

BlocRefList

A list of all blocref entries, for a specific tag.

BlogPost

Defines a blog post.

BlogPostDirective

Extracts information about a blog post described by a directive ``

BlogPostDirectiveAgg

same but for the same post in a aggregated pages

BlogPostList

Defines a list of BlogPost.

BlogPostListDirective

unused, kept as example

BlogPostParseError

Exception raised when a error comes after a blogpost was parsed.

BokehPlotDirective

Sphinx directive.

BufferedPrint

Buffered display. Relies on io.StringIO. Use it as follows

CannotCompleteWithoutNewLoginException

raised when a transfer is interrupted by a new login

CannotDownloadException

Raised by function get_url_content() if something cannot be downloaded.

CannotReturnToFolderException

raised when a transfer is interrupted by an exception and the class cannot return to the original folder

ClassStruct

Class as struct.

ClassStruct

Class as struct.

CmdRef

A cmdref entry, displayed in the form of an admonition. It is used to reference a script a module is added as a …

CmdRefList

A list of all cmdref entries, for a specific tag.

CollapseDirective

A collapse adds hide/unhide button for a part of HTML page. It has no effect in other formats.

CommonSphinxWriterHelpers

Common functions used in RstTranslator and MdTranslator.

Convert3to2Exception

exception raised for an exception happening during the conversion

CoverageException

raised when an issue happens with the coverage

CustomAdaptersTocTree

Sphinx directive

CustomLog

Implements a custom logging function. This class is not protected against multithreading. Usage:

CustomSphinxApp

A subclass of class Sphinx, the goal is to interpret RST with custom directives.

CustomTemplateException

Raised when a templatre could not compile.

CustomTocTree

Overwrites toctree. The code is located …

CustomTocTreeCollector

Overwrites TocTreeCollector. …

CustomizedSphinxFileOutput

Customized FileOutput class for Sphinx.

DocTreeBuilder

Defines a doctree builder.

DocTreeTranslator

Defines a translator for doctree

DocTreeTranslatorWithCustomDirectives

See HTMLWriterWithCustomDirectives.

DocTreeWriter

Defines a doctree writer.

DocTreeWriterWithCustomDirectives

This docutils writer creates a doctree writer with custom directives implemented in this module.

DocumentationHandler

Define a simple handler used by HTTPServer, it just serves local content.

DocumentationThreadServer

defines a thread which holds a web server

DownloadLinkFileCollector

Download files collector for sphinx.environment.

Doxypy

DropDownWidget

drop down list

EncryptedBackup

This class aims at keeping an encrypted and compressed backup of files. Every file is compressed and then encrypted …

EncryptedBackupError

raised by EncryptedBackup

EncryptionError

raised if an issue happen during encryption

EnhancedLaTeXBuilder

Overwrites LaTeXBuilder.

EnhancedLaTeXTranslator

Overwrites LaTeXTranslator and modifies …

EnhancedLaTeXWriter

Overwrites LatexWriter.

ErrorOnPurpose

raise to get the call stack

ExRef

A exref entry, displayed in the form of an admonition. It takes the following options:

ExRefList

A list of all exref entries, for a specific tag.

ExtTestCase

Overwrites unit test class with additional testing functions. Unless setUp is overwritten, warnings FutureWarning

FSM

Implements a finite state machine. Transitions are given as 4-tuples, consisting of an origin state, a target state, …

FaqRef

A faqref entry, displayed in the form of an admonition. It takes the following options:

FaqRefList

A list of all faqref entries, for a specific tag.

FileException

Exception related to files.

FileInfo

intermediate class: it represents the data it collects about a file to determine whether or not it was modified

FileTreeNode

Defines a node for a folder or a tree. Example:

FilesStatus

This class maintains a list of files and does some verifications in order to check if a file was modified or not …

FlogStatic

static variable for the log

FolderTransferFTP

This class aims at transfering a folder to a FTP website, it checks that a file was updated before transfering, …

FolderTransferFTPException

custom exception for FolderTransferFTP

GDotDirective

A gdot node displays a DOT graph. The build choose SVG for HTML format and image for …

GitException

Exception raised by this module.

GitHubApiException

Exception raised when a call to github rest api failed.

GitLabAPI

Wrapper around GitLab Server. The API is defined at gitlabhq/doc/api

GitLabException

specific exception, stores the request

GridBenchMark

Compares a couple of machine learning models.

HTMLTranslatorWithCustomDirectives

See HTMLWriterWithCustomDirectives.

HTMLWriterWithCustomDirectives

This docutils writer extends the HTML writer with custom directives implemented in this module, RunPythonDirective, …

HelpGenConvertError

Exception raised when a conversion failed.

HelpGenException

custom exception

ImageDirective

Directive which overrides default sphinx directive. It’s backward compatibile and it’s adding more cool stuff.

ImportErrorHelpGen

A custom exception to detect a specific location when ImportError happens in the process.

InNotebookException

Exception raises when something wrong happened in a notebook.

IndexInformation

Keeps some information to index.

InternetException

Exception for the function get_url_content_timeout()

JenkinsExt

Extensions for the Jenkins server based on module python-jenkins.

JenkinsExtException

Exception for the class JenkinsExt.

JenkinsExtPyException

Exception for the class JenkinsExt, when a distribution is not available.

JenkinsJobException

Exception for the class JenkinsExt, the job definition is wrong.

JupyterException

Exception raises by Jupyter.

LatexRawOutputPreprocessor

Custom processor to apply a different style on raw output.

LatexTranslatorWithCustomDirectives

See LatexWriterWithCustomDirectives.

LatexWriterWithCustomDirectives

This docutils writer extends the Latex writer with custom directives implemented in this module.

LightBox2

Backend for sphinx directive image.

LogFakeFileStream

a fake file

LogFileStream

log as writing in a file

MDTranslatorWithCustomDirectives

See HTMLWriterWithCustomDirectives.

MDWriterWithCustomDirectives

This docutils writer extends the MD writer with custom directives implemented in this module.

MagicClassExample

MagicClassWithHelpers

Provides some functions reused in others classes inherited from Magics. The class should not be registered as it is …

MagicCommandParser

Adds method parse_cmd to argparse.ArgumentParser.

MagicCompress

Defines magic commands to compress files.

MagicCrypt

Defines magic commands to encrypt and decrypt file.

MagicDiff

Defines magic commands to visualize differences between files.

MathDef

A mathdef entry, displayed in the form of an admonition. It takes the following options:

MathDefList

A list of all mathdef entries, for a specific tag.

MdBuilder

Defines a MD builder.

MdTranslator

Defines a MD translator.

MdWriter

Defines a MD writer.

MemoryDocTreeBuilder

Builds doctree output in memory. The API is defined by the page builderapi.

MemoryHTMLBuilder

Builds HTML output in memory. The API is defined by the page builderapi.

MemoryLatexBuilder

Builds Latex output in memory. The API is defined by the page builderapi.

MemoryMDBuilder

Builds MD output in memory. The API is defined by the page builderapi.

MemoryRSTBuilder

Builds RST output in memory. The API is defined by the page builderapi. The writer simplifies …

MockSphinxApp

Mocks Sphinx application. In memory Sphinx application.

MockTransferAPI

class used for unit test purposes, simple key, value storage

MockTransferFTP

mock TransferFTP

MockTransferFTP

mock TransferFTP

ModuleMemberDoc

Represents a member in a module. See inspect. Attributes:

NbRef

A nbref entry, displayed in the form of an admonition. It takes the following options:

NbRefList

A list of all nbref entries, for a specific tag.

NodeEnter

Returned by function traverse().

NodeJsException

Raised if node.js fails.

NodeLeave

Returned by function traverse().

NotImplementedErrorFromVirtualEnvironment

Defines an exception when a function does not work in a virtual environment.

NotebookConvertError

Exception raised when a conversion failed.

NotebookError

Raised when the execution fails.

NotebookException

Exception raises when something wrong happened with a notebook.

NotebookKernelError

Raised when wait_for_ready

NotebookRunner

The kernel communicates with mime-types while the notebook uses short labels for different cell types. We’ll use this …

Opt

OverrideDocFieldTransformer

Overrides one function with assigning it to a method

PEP8Exception

Code or style issues.

PQHException

custom exception for this file

PQHException

Define an exception.

PQPipError

any exception raised by one of the following function

PYQImageException

Some exceptions about images.

PlotScriptError

Error during script parsing.

PlotScriptParser

This Parser recognizes .py files in the Sphinx source tree, assuming that they contain bokeh examples Note: it …

PostContentsDirective

Defines a sphinx extension which proposes a new version of ``

QuoteNode

A quotedef entry, displayed in the form of an admonition. It takes the following options:

RSTTranslatorWithCustomDirectives

See HTMLWriterWithCustomDirectives.

RSTWriterWithCustomDirectives

This docutils writer extends the RST writer with custom directives implemented in this module.

RadioWidget

radio button

RangeWidget

Range (slider) widget The class overloads html and …

ReadUrlException

Raised by read_url().

RepoFile

Mimic a GIT file.

RepoFile

mimic a svn file

RevealjsDirective

Reveal.JS slide entry

RstBuilder

Defines a RST builder.

RstFileHelp

Defines what a rst file and what it describes.

RstTranslator

Defines a RST translator.

RstWriter

Defines a RST writer.

RunCmdException

Raised by function run_cmd().

RunPythonCompileError

exception raised when a piece of code included in the documentation does not compile

RunPythonDirective

Extracts script to run described by ``

RunPythonExecutionError

Exception raised when a piece of code included in the documentation raises an exception.

RvCodeDirective

Directive for a code block with highlight.js

RvNoteDirective

Directive for a notes tag.

RvSmallDirective

Create small text tag.

SetupHookException

raised when something happen while running setup_hook

ShareNetDirective

Adds buttons to share a page. It can be done by adding

SimpleImageDirective

Adds an image to a page. It can be done by adding

SourceRepository

Proposes the same functionality independent from the source chosen repository (GIT or SVN). On Windows, it might …

SphinxVerificationException

to format the error message

StaticInteract

Static Interact Object See notebook Having a form in a notebook.

StaticWidget

Base Class for Static Widgets

StringIOAndFile

Overloads a StringIO to also writes in a file.

TestExecutionError

Raised when the execution of a test fails.

TestWrappedException

Raised by @see fn main_wrapper_tests

TinyNode

Returned by traverse().

TocDelayDirective

Defines a sphinx extension which proposes a new version of ``

TodoExt

A todoext entry, displayed in the form of an admonition. It takes the following options:

TodoExtList

A list of all todoext entries, for a specific tag.

TransferAPI

defines an API to transfer files over a remote location

TransferAPIFile

defines an API to transfer files over another location

TransferAPIFtp

defines an API to transfer files over a remote location through FTP

TransferAPI_FileInfo

keeps tracks of transferred files

TransferFTP

this class uploads files to a website, if the remote does not exists, it creates it first

UpgradedRSTExporter

Exports rst documents. Overwrites RSTExporter. …

VideoDirective

Adds video to a page. It can be done by adding

VirtualEnvError

Exception raised by the function implemented in this file.

WinZipFile

Overwrite method zipfile.ZipFile.open. Issue 6839 happens when …

WrappedNode

Wraps a docutils node.

YoutubeDirective

Youtube directive.

_AdditionalVisitDepart

Additional visitors and departors.

_AsyncLineReader

_CustomBuildEnvironment

Overrides some functionalities of BuildEnvironment.

_CustomSphinx

Custom Sphinx application to avoid using disk.

_MemoryBuilder

Builds HTML output in memory. The API is defined by the page builderapi.

_Types

_WriterWithCustomDirectives

Common class to HTMLWriterWithCustomDirectives and RSTWriterWithCustomDirectives.

autosignature_node

Defines autosignature node.

bigger_node

Defines bigger node.

blocref_node

Defines blocref node.

blocreflist

defines blocreflist node

blogpost_node

Defines blogpost node.

blogpostagg_node

Defines blogpostagg node.

blogpostlist_node

defines blogpostlist node, unused, kept as example

cmdref_node

defines cmdref node

cmdreflist

defines cmdreflist node

collapse_node

defines collapse node.

downloadlink_node

Defines download_reference node.

epkg_node

Defines epkg node.

exref_node

defines exref ndoe

exreflist

defines exreflist node

faqref_node

defines faqref ndoe

faqreflist

defines faqreflist node

gallery_node

sphinx node

gdot_node

defines gdot node.

githublink_node

defines githublink node

gitlog_node

Defines gitlog node.

image_node

sphinx node

mathdef_node

Defines mathdef node.

mathdeflist

Defines mathdeflist node.

nbref_node

defines nbref ndoe

nbreflist

defines nbreflist node

open_stream_file

Opens a stream or a filename. It works with keyword with.

postcontents_node

defines postcontents node

python_path_append

Appends one path into PYTHONPATH.

quote_node

Defines quote node.

revealjs

node for revealjs

runpython_node

defines runpython node

rv_code

node for revealjs code section

rv_note

node for revealjs presentation note

rv_small

node for revealjs small text section

sharenet_node

Defines sharenet node.

simpleimage_node

Defines image node.

sys_path_append

Stores the content of sys.path and restores it afterwards.

tocdelay_node

defines tocdelay node

todoext_node

Defines todoext node.

todoextlist

Defines todoextlist node.

tpl_node

Defines tpl node.

useless_class_UnicodeStringIOThreadSafe

avoid conversion problem between str and char, class protected again Thread issue

video_node

Defines video node.

youtube_node

Youtube node.