.. _l-classes: Classes ======= .. contents:: :local: :depth: 1 Summary +++++++ +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | class | class parent | truncated documentation | +================================================================================================================================================+==============+==============================================================================================================================================+ | :class:`AutoCompletion ` | | You can add auto completion object to IPython by adding member to an instance of this class. All members must begin ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`AutoCompletionFile ` | | builds a tree based on a list of files, the class adds ``A__`` before every folder or file starting with ``_`` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`AutoSignatureDirective ` | | This directive displays a shorter signature than :epkg:`sphinx.ext.autodoc`. Available options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Backend ` | | Backend API for sphinx directive *image*. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BenchMark ` | | Class to help benchmarking. You should overwrite method *init*, *bench*, *end*, *graphs*. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlocRef ` | | A ``blocref`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlocRefList ` | | A list of all blocref entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlogPost ` | | Defines a blog post. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlogPostDirective ` | | Extracts information about a blog post described by a directive `` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlogPostDirectiveAgg ` | | same but for the same post in a aggregated pages | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlogPostList ` | | Defines a list of :class:`BlogPost`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlogPostListDirective ` | | unused, kept as example | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BlogPostParseError ` | | Exception raised when a error comes after a blogpost was parsed. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`BufferedPrint ` | | Buffered display. Relies on :epkg:`*py:io:StringIO`. Use it as follows: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CannotCompleteWithoutNewLoginException ` | | raised when a transfer is interrupted by a new login | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CannotDownloadException ` | | Raised by function :func:`get_url_content` if something cannot be downloaded. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CannotReturnToFolderException ` | | raised when a transfer is interrupted by an exception and the class cannot return to the original folder | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ClassStruct ` | | Class as struct. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ClassStruct ` | | Class as struct. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CmdRef ` | | A ``cmdref`` entry, displayed in the form of an admonition. It is used to reference a script a module is added as a ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CmdRefList ` | | A list of all *cmdref* entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CollapseDirective ` | | A ``collapse`` adds hide/unhide button for a part of HTML page. It has no effect in other formats. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CommonSphinxWriterHelpers ` | | Common functions used in :class:`RstTranslator` and :class:`MdTranslator`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Convert3to2Exception ` | | exception raised for an exception happening during the conversion | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CoverageException ` | | raised when an issue happens with the coverage | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomAdaptersTocTree ` | | :epkg:`Sphinx` directive | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomLog ` | | Implements a custom logging function. This class is not protected against multithreading. Usage: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomSingleFileHTMLBuilder ` | | A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomSphinxApp ` | | A subclass of class *Sphinx*, the goal is to interpret :epkg:`RST` with custom directives. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomTemplateException ` | | Raised when a templatre could not compile. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomTocTree ` | | Overwrites `toctree `_. The code is ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomTocTreeCollector ` | | Overwrites `TocTreeCollector `_. ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`CustomizedSphinxFileOutput ` | | Customized FileOutput class for :epkg:`Sphinx`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Distribution ` | | Common interface for old and recent pip packages. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeBuilder ` | | Defines a doctree builder. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeTranslator ` | | Defines a translator for doctree | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeTranslatorWithCustomDirectives ` | | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeWriter ` | | Defines a doctree writer. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeWriterWithCustomDirectives ` | | This :epkg:`docutils` writer creates a doctree writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocumentationHandler ` | | Define a simple handler used by HTTPServer, it just serves local content. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocumentationThreadServer ` | | defines a thread which holds a web server | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DownloadLinkFileCollector ` | | Download files collector for *sphinx.environment*. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Doxypy ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DropDownWidget ` | | drop down list | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DummySphinxTheme ` | | Dummy theme for sphinx. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`EncryptedBackup ` | | This class aims at keeping an encrypted and compressed backup of files. Every file is compressed and then encrypted ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`EncryptedBackupError ` | | raised by :class:`EncryptedBackup` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`EncryptionError ` | | raised if an issue happen during encryption | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`EnhancedLaTeXBuilder ` | | Overwrites `LaTeXBuilder `_. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`EnhancedLaTeXTranslator ` | | Overwrites `LaTeXTranslator `_ and modifies ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`EnhancedLaTeXWriter ` | | Overwrites `LatexWriter `_. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ErrorOnPurpose ` | | raise to get the call stack | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ExRef ` | | A ``exref`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ExRefList ` | | A list of all *exref* entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ExtTestCase ` | | Overwrites unit test class with additional testing functions. Unless *setUp* is overwritten, warnings *FutureWarning* ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FSM ` | | Implements a finite state machine. Transitions are given as 4-tuples, consisting of an origin state, a target state, ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FaqRef ` | | A ``faqref`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FaqRefList ` | | A list of all *faqref* entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FileException ` | | Exception related to files. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FileInfo ` | | Intermediate class: it represents the data it collects about a file to determine whether or not it was modified. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FileTreeNode ` | | Defines a node for a folder or a tree. Example: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FilesStatus ` | | This class maintains a list of files and does some verifications in order to check if a file was modified or not ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FlogStatic ` | | static variable for the log | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FolderTransferFTP ` | | This class aims at transfering a folder to a FTP website, it checks that a file was updated before transfering, ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`FolderTransferFTPException ` | | custom exception for :class:`FolderTransferFTP` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`GDotDirective ` | | A ``gdot`` node displays a :epkg:`DOT` graph. The build choose :epkg:`SVG` for :epkg:`HTML` format and image for ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`GitException ` | | Exception raised by this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`GitHubApiException ` | | Exception raised when a call to github rest api failed. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`GitLabAPI ` | | Wrapper around GitLab Server. The API is defined at `gitlabhq/doc/api `_ ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`GitLabException ` | | specific exception, stores the request | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`GridBenchMark ` | | Compares a couple of machine learning models. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`HTMLTranslatorWithCustomDirectives ` | | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`HTMLWriterWithCustomDirectives ` | | This :epkg:`docutils` writer extends the HTML writer with custom directives implemented in this module, :class:`RunPythonDirective`, ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`HelpGenConvertError ` | | Exception raised when a conversion failed. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`HelpGenException ` | | custom exception | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ImageDirective ` | | Directive which overrides default sphinx directive. It's backward compatibile and it's adding more cool stuff. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ImportErrorHelpGen ` | | A custom exception to detect a specific location when *ImportError* happens in the process. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`InNotebookException ` | | Exception raises when something wrong happened in a notebook. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`IndexInformation ` | | Keeps some information to index. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`InternetException ` | | Exception for the function :func:`get_url_content_timeout` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Item ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`JenkinsExt ` | | Extensions for the :epkg:`Jenkins` server based on module :epkg:`python-jenkins`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`JenkinsExtException ` | | Exception for the class :class:`JenkinsExt`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`JenkinsExtPyException ` | | Exception for the class :class:`JenkinsExt`, when a distribution is not available. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`JenkinsJobException ` | | Exception for the class :class:`JenkinsExt`, the job definition is wrong. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`JupyterException ` | | Exception raises by :epkg:`Jupyter`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LatexRawOutputPreprocessor ` | | Custom processor to apply a different style on raw output. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LatexTranslatorWithCustomDirectives ` | | See :class:`LatexWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LatexWriterWithCustomDirectives ` | | This :epkg:`docutils` writer extends the :epkg:`Latex` writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LightBox2 ` | | Backend for sphinx directive ``image``. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LogFakeFileStream ` | | a fake file | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LogFileStream ` | | log as writing in a file | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MDTranslatorWithCustomDirectives ` | | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MDWriterWithCustomDirectives ` | | This :epkg:`docutils` writer extends the :epkg:`MD` writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MagicClassExample ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MagicClassWithHelpers ` | | Provides some functions reused in others classes inherited from *Magics*. The class should not be registered as it is ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MagicCommandParser ` | | Adds method ``parse_cmd`` to :epkg:`*py:argparse:ArgumentParser`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MagicCompress ` | | Defines magic commands to compress files. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MagicCrypt ` | | Defines magic commands to encrypt and decrypt file. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MagicDiff ` | | Defines magic commands to visualize differences between files. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MathDef ` | | A ``mathdef`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MathDefList ` | | A list of all mathdef entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MdBuilder ` | | Defines a :epkg:`MD` builder. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MdTranslator ` | | Defines a :epkg:`MD` translator. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MdWriter ` | | Defines a :epkg:`MD` writer. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryDocTreeBuilder ` | | Builds doctree output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryHTMLBuilder ` | | Builds :epkg:`HTML` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryLatexBuilder ` | | Builds :epkg:`Latex` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryMDBuilder ` | | Builds :epkg:`MD` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryRSTBuilder ` | | Builds :epkg:`RST` output in memory. The API is defined by the page :epkg:`builderapi`. The writer simplifies ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Metric ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MockSphinxApp ` | | Mocks :epkg:`Sphinx` application. In memory :epkg:`Sphinx` application. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MockTransferAPI ` | | Class used for unit test purposes, simple key, value storage. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MockTransferFTP ` | | mock :class:`TransferFTP` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MockTransferFTP ` | | mock :class:`TransferFTP` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ModuleMemberDoc ` | | Represents a member in a module. See :epkg:`*py:inspect`. Attributes: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NbRef ` | | A ``nbref`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NbRefList ` | | A list of all *nbref* entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NodeEnter ` | | Returned by function :func:`traverse`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NodeJsException ` | | Raised if :epkg:`node.js` fails. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NodeLeave ` | | Returned by function :func:`traverse`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NotImplementedErrorFromVirtualEnvironment ` | | Defines an exception when a function does not work in a virtual environment. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NotebookConvertError ` | | Exception raised when a conversion failed. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NotebookError ` | | Raised when the execution fails. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NotebookException ` | | Exception raises when something wrong happened with a notebook. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NotebookKernelError ` | | Raised when `wait_for_ready `_ ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`NotebookRunner ` | | The kernel communicates with mime-types while the notebook uses short labels for different cell types. We'll use this ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Opt ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`OverrideDocFieldTransformer ` | | Overrides one function with assigning it to a method | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`PEP8Exception ` | | Code or style issues. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`PQHException ` | | custom exception for this file | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`PQHException ` | | Define an exception. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`PQPipError ` | | Any exception raised by one of the following function. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`PYQImageException ` | | Some exceptions about images. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`PostContentsDirective ` | | Defines a sphinx extension which proposes a new version of `` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ProfileNode ` | | Graph structure to represent a profiling. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`Query ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`QueryL ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`QuoteNode ` | | A ``quotedef`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RSTTranslatorWithCustomDirectives ` | | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RSTWriterWithCustomDirectives ` | | This :epkg:`docutils` writer extends the :epkg:`RST` writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RadioWidget ` | | radio button | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RangeWidget ` | | Range (slider) widget The class overloads :meth:`html ` and ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RateLimitedServerProxy ` | | See this `issue `_. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ReadUrlException ` | | Raised by :func:`read_url`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RepoFile ` | | Mimic a :epkg:`GIT` file. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RepoFile ` | | mimic a svn file | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RevealjsDirective ` | | Reveal.JS slide entry | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RstBuilder ` | | Defines a :epkg:`RST` builder. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RstFileHelp ` | | Defines what a rst file and what it describes. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RstTranslator ` | | Defines a :epkg:`RST` translator. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RstWriter ` | | Defines a :epkg:`RST` writer. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RunCmdException ` | | Raised by function :func:`run_cmd`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RunPythonCompileError ` | | exception raised when a piece of code included in the documentation does not compile | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RunPythonDirective ` | | Extracts script to run described by `` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RunPythonExecutionError ` | | Exception raised when a piece of code included in the documentation raises an exception. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RvCodeDirective ` | | Directive for a code block with highlight.js | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RvNoteDirective ` | | Directive for a notes tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RvSmallDirective ` | | Create small text tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`ShareNetDirective ` | | Adds buttons to share a page. It can be done by adding | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`SimpleImageDirective ` | | Adds an image to a page. It can be done by adding | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`SortKey ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`SourceRepository ` | | Proposes the same functionality independent from the source chosen repository (GIT or SVN). On Windows, it might ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`SphinxVerificationException ` | | to format the error message | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`SqlLite3FileStore ` | | Simple file storage implemented with :epkg:`python:sqlite3`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`StaticInteract ` | | Static Interact Object See notebook :ref:`havingaforminanotebookrst`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`StaticWidget ` | | Base Class for Static Widgets | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`StringIOAndFile ` | | Overloads a StringIO to also writes in a file. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TestExecutionError ` | | Raised when the execution of a test fails. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TestWrappedException ` | | Raised by @see fn main_wrapper_tests | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TinyNode ` | | Returned by :func:`traverse`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TocDelayDirective ` | | Defines a :epkg:`sphinx` extension which proposes a new version of `` | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TodoExt ` | | A ``todoext`` entry, displayed in the form of an admonition. It takes the following options: | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TodoExtList ` | | A list of all todoext entries, for a specific tag. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TransferAPI ` | | Defines an API to transfer files over a remote location. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TransferAPIFile ` | | Defines an API to transfer files over another location. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TransferAPIFtp ` | | Defines an API to transfer files over a remote location through :epkg:`FTP`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TransferAPI_FileInfo ` | | Keeps tracks of transferred files. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`TransferFTP ` | | This class uploads files to a website, if the remote does not exists, it creates it first. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`UpgradedRSTExporter ` | | Exports :epkg:`rst` documents. Overwrites `RSTExporter `_. ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`VideoDirective ` | | Adds video to a page. It can be done by adding | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`VirtualEnvError ` | | Exception raised by the function implemented in this file. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`WinZipFile ` | | Overwrite method :epkg:`*py:zipfile:ZipFile:open`. Issue `6839 `_ happens when ... | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`WrappedNode ` | | Wraps a docutils node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`YoutubeDirective ` | | Youtube directive. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_AdditionalVisitDepart ` | | Additional visitors and departors. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_AsyncLineReader ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_BodyPlaceholder ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_CustomBuildEnvironment ` | | Overrides some functionalities of `BuildEnvironment `_. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_CustomSphinx ` | | Custom :epkg:`Sphinx` application to avoid using disk. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_MemoryBuilder ` | | Builds :epkg:`HTML` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_Types ` | | | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_WriterWithCustomDirectives ` | | Common class to :class:`HTMLWriterWithCustomDirectives` and :class:`RSTWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`autosignature_node ` | | Defines *autosignature* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`bigger_node ` | | Defines *bigger* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`blocref_node ` | | Defines ``blocref`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`blocreflist ` | | defines ``blocreflist`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`blogpost_node ` | | Defines *blogpost* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`blogpostagg_node ` | | Defines *blogpostagg* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`blogpostlist_node ` | | defines *blogpostlist* node, unused, kept as example | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`cmdref_node ` | | defines ``cmdref`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`cmdreflist ` | | defines ``cmdreflist`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`collapse_node ` | | defines ``collapse`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`downloadlink_node ` | | Defines *download_reference* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`epkg_node ` | | Defines *epkg* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`exref_node ` | | defines ``exref`` ndoe | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`exreflist ` | | defines ``exreflist`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`faqref_node ` | | defines ``faqref`` ndoe | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`faqreflist ` | | defines ``faqreflist`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`gallery_node ` | | :epkg:`sphinx` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`gdot_node ` | | defines ``gdot`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`githublink_node ` | | defines *githublink* node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`gitlog_node ` | | Defines *gitlog* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`image_node ` | | :epkg:`sphinx` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`mathdef_node ` | | Defines ``mathdef`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`mathdeflist ` | | Defines ``mathdeflist`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`nbref_node ` | | defines ``nbref`` ndoe | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`nbreflist ` | | defines ``nbreflist`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`open_stream_file ` | | Opens a stream or a filename. It works with keyword ``with``. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`postcontents_node ` | | defines ``postcontents`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`python_path_append ` | | Appends one path into ``PYTHONPATH``. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`quote_node ` | | Defines ``quote`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`revealjs ` | | node for revealjs | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`runpython_node ` | | Defines *runpython* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`rv_code ` | | node for revealjs code section | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`rv_note ` | | node for revealjs presentation note | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`rv_small ` | | node for revealjs small text section | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`sharenet_node ` | | Defines *sharenet* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`simpleimage_node ` | | Defines *image* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`sys_path_append ` | | Stores the content of :epkg:`*py:sys:path` and restores it afterwards. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`tocdelay_node ` | | defines ``tocdelay`` node | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`todoext_node ` | | Defines ``todoext`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`todoextlist ` | | Defines ``todoextlist`` node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`tpl_node ` | | Defines *tpl* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`useless_class_UnicodeStringIOThreadSafe ` | | avoid conversion problem between str and char, class protected again Thread issue | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`video_node ` | | Defines *video* node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`youtube_node ` | | Youtube node. | +------------------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------+