.. _l-methods: Methods ======= .. contents:: :local: :depth: 1 Summary +++++++ +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | method | class parent | truncated documentation | +=========================================================================================================================================================+=========================================+======================================================================================================================================================================================================+ | :meth:`LOG ` | DocumentationHandler | logging function | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`SetGuessedType ` | SourceRepository | Guesses the repository type given a location and changes a member of the class. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__add__ ` | NotebookRunner | Merges two notebooks together, returns a new none. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__call__ ` | CustomLog | Log anything. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__closeComment ` | Doxypy | Appends any open comment block and triggering block to the output. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__cmp__ ` | ModuleMemberDoc | Comparison operators, compares first the first, second the name (lower case). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__cmp__ ` | BlogPost | This method avoids to get the following error ``TypeError: unorderable types: BlogPost() < BlogPost()``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__del__ ` | NotebookRunner | We close the kernel. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__del__ ` | CustomLog | Closes the stream if needed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__docstringSummaryToBrief ` | Doxypy | Adds \brief to the docstrings summary line. A \brief is prepended, provided no other doxygen command is at the ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__enter__ ` | open_stream_file | Opens the stream or the file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__enter__ ` | python_path_append | Modifies ``os.environ['PYTHONPATH']``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__enter__ ` | sys_path_append | Modifies ``sys.path``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__eq__ ` | ModuleMemberDoc | Operator ``==``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__exit__ ` | open_stream_file | Leaves the stream or the filename. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__exit__ ` | python_path_append | Restores``sys.path``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__exit__ ` | sys_path_append | Restores``sys.path``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__flushBuffer ` | Doxypy | Flushes the current outputbuffer to the outstream. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__getattr__ ` | RateLimitedServerProxy | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__getattr__ ` | Distribution | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__getitem__ ` | FileTreeNode | returns the element i | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__getitem__ ` | BlogPostList | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__gt__ ` | ModuleMemberDoc | Operator ``>``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | BenchMark | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | GridBenchMark | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | EncryptedBackup | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FileInfo | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FileTreeNode | Defines a file, relative to a root. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FilesStatus | file which will contains the status | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MockTransferFTP | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TransferFTP | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FolderTransferFTP | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MockTransferFTP | same signature as :class:`TransferFTP` | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MockTransferAPI | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TransferAPI | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TransferAPI_FileInfo | Information about a transferred file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TransferAPIFile | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TransferAPIFtp | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Doxypy | Constructor for Doxypy. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FSM | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Opt | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | LatexRawOutputPreprocessor | Overloads the constructor. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | HelpGenException | redefines the message sent to an exception | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | UpgradedRSTExporter | Overwrites the extra loaders to get the right template. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | SphinxVerificationException | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocTreeTranslatorWithCustomDirectives | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocTreeWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | HTMLWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | LatexTranslatorWithCustomDirectives | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | LatexWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MDTranslatorWithCustomDirectives | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MDWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MemoryDocTreeBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MemoryHTMLBuilder | Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MemoryLatexBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MemoryMDBuilder | Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MemoryRSTBuilder | Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RSTTranslatorWithCustomDirectives | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RSTWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | _CustomBuildEnvironment | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | _CustomSphinx | Same constructor as :epkg:`Sphinx application`. Additional parameters: | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | CustomSphinxApp | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MockSphinxApp | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | useless_class_UnicodeStringIOThreadSafe | creates a lock | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | IndexInformation | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | ModuleMemberDoc | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RstFileHelp | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | StaticInteract | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | AutoCompletion | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | AutoCompletionFile | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MagicCommandParser | custom constructor, see :epkg:`*py:argparse:ArgumentParser`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | NotebookRunner | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DropDownWidget | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RadioWidget | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RangeWidget | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | StaticWidget | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | JenkinsExt | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | BufferedPrint | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | CustomLog | initialisation | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FlogStatic | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | LogFakeFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | LogFileStream | creates a logger | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | GitHubApiException | Merges everything into a string. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | open_stream_file | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | PQHException | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | SourceRepository | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | GitLabAPI | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | GitLabException | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RepoFile | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RepoFile | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | _AsyncLineReader | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | python_path_append | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | sys_path_append | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Distribution | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | PQPipError | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | ProfileNode | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TestExecutionError | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | StringIOAndFile | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocumentationHandler | Regular constructor, an instance is created for each request, do not store any data for a longer time than a request. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocumentationThreadServer | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | SqlLite3FileStore | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | BlogPost | Creates an instance of a blog post from a file or a string. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | BlogPostList | Creates a list of :class:`BlogPost`, we assume each blog post belongs to a subfolder ``YYYY``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | OverrideDocFieldTransformer | Constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocTreeBuilder | Constructor, add a logger. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DocTreeWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | ClassStruct | All arguments are added to the class. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | NodeEnter | Create a note | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | NodeLeave | Create a note | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | TinyNode | Create a note | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | WrappedNode | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | CustomizedSphinxFileOutput | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | DummySphinxTheme | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | EnhancedLaTeXBuilder | Constructor, add a logger. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | EnhancedLaTeXWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MdBuilder | Constructor, add a logger. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MdWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RstBuilder | Constructor, add a logger. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | RstWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | _BodyPlaceholder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | ClassStruct | All arguments are added to the class. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Backend | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__iter__ ` | FileTreeNode | iterator on the element | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__iter__ ` | FilesStatus | Iterates on all files stored in the current file, yield a couple *(filename, FileInfo)*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__iter__ ` | ProfileNode | Returns all nodes in the graph. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__iter__ ` | BlogPostList | Iterates on :class:`BlogPost`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | FileTreeNode | Returns the number of elements in this folder and in the subfolders. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | AutoCompletion | returns the number of elements | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | AutoCompletionFile | returns the number of elements | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | NotebookRunner | Returns the number of cells, it iterates on cells to get this information and does cache the information. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | BlogPostList | Returns the number of blog posts. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__lt__ ` | ModuleMemberDoc | Operator ``<``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__lt__ ` | BlogPost | Tells if this blog should be placed before *other*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | DropDownWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | RadioWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | RangeWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | StaticWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | ProfileNode | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | FileInfo | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | FileTreeNode | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | FolderTransferFTP | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | TransferAPI_FileInfo | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | CustomSphinxApp | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | IndexInformation | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | ModuleMemberDoc | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | AutoCompletion | returns a string | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | AutoCompletionFile | returns a string | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | BufferedPrint | Returns the content. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | GitLabException | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | RepoFile | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | RepoFile | usual | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add ` | AutoCompletion | add a member to this class, add an ``AutoCompletion`` instance, creates one if value is not from ``AutoCompletion`` ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add ` | AutoCompletionFile | add a member to this class, add an ``AutoCompletion`` instance, creates one if value is not from ``AutoCompletion`` ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add_missing_element_in_config ` | CustomSphinxApp | Adds extra elements in config such as ``latex_elements``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add_missing_ids ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_cell_container ` | NotebookRunner | Returns a cells container, it may change according to the format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_can_logged ` | TransferFTP | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_init_ ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_same_column ` | SqlLite3FileStore | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_thumbnail_tuple ` | NotebookRunner | Checks types for a thumbnail. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_convert ` | BenchMark | Converts a value knowing its column, its type into something readable. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_create ` | SqlLite3FileStore | Creates the database if it does not exists. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_enumerate ` | SqlLite3FileStore | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_extended_init_ ` | _CustomSphinx | Additional initialization steps. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_fill ` | FileTreeNode | look for subfolders | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_fillstat ` | FileTreeNode | private: fill _type, _size | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_filter ` | AutoCompletionFile | Removes unexpected characters for a file name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_format_obj ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_get_column_table ` | SqlLite3FileStore | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_get_connexion ` | SqlLite3FileStore | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_get_filename ` | MemoryLatexBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_get_filename ` | EnhancedLaTeXBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_get_local_toctree ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | DocTreeWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | HTMLWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | LatexWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | MDWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | MemoryDocTreeBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | MemoryHTMLBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | MemoryLatexBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | MemoryMDBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | MemoryRSTBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | RSTWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | _MemoryBuilder | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | _WriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init_builder ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init_env ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_lookup_doctree ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_merge_images ` | NotebookRunner | Merges images defined by (buffer, format). The method uses PIL to merge images when possible. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_output_html ` | StaticInteract | html output | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_populate ` | AutoCompletionFile | populate the class with files and folder in the folder this class holds | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_private_login ` | TransferFTP | logs in | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_repr_html_ ` | StaticInteract | Synonym for :meth:`html `. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_repr_html_ ` | DropDownWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_repr_html_ ` | RadioWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_repr_html_ ` | RangeWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_repr_html_ ` | StaticWidget | operator, call method html | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_scale_image ` | NotebookRunner | Scales an image with the same aspect ratio centered in an image with a given max_width and max_height. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_setup_jenkins_server_job_iteration ` | JenkinsExt | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_setup_jenkins_server_modules_loop ` | JenkinsExt | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_single_option ` | DropDownWidget | private | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_single_radio ` | RadioWidget | private | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_update_link ` | BlogPost | Changes a link to an image if the page contains one into *year/img.png*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_update_title ` | BlocRef | Updates the title for the bloc itself. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_widget_html ` | StaticInteract | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | MemoryDocTreeBuilder | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | MemoryHTMLBuilder | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | MemoryLatexBuilder | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | MemoryMDBuilder | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | MemoryRSTBuilder | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | _MemoryBuilder | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | MemoryDocTreeBuilder | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | MemoryHTMLBuilder | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | MemoryLatexBuilder | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | MemoryMDBuilder | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | MemoryRSTBuilder | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | _MemoryBuilder | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`addTransition ` | FSM | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_argument ` | MagicCommandParser | Overloads the method, see `ArgumentParser `_. Among the ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_autodocumenter ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_builder ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_builder ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_called_by ` | ProfileNode | This function is called by these lines. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_calls_to ` | ProfileNode | This function calls this node. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_config_value ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_config_value ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | DocTreeWriterWithCustomDirectives | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | HTMLWriterWithCustomDirectives | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | LatexWriterWithCustomDirectives | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | MDWriterWithCustomDirectives | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | RSTWriterWithCustomDirectives | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | _WriterWithCustomDirectives | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_context ` | MagicClassWithHelpers | add context to the class, mostly for debug purpose | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_css_file ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_css_file ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_directive ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_directive ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_directive_to_domain ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_domain ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_domain ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_env_collector ` | _CustomSphinx | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_env_collector ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_event ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_event ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_generic_role ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_if_modified ` | FilesStatus | Adds a file to self.modifiedList if it was modified. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_js_file ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_js_file ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_label_if_not_present ` | IndexInformation | The function checks the label is present in the original file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_latex_package ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_mapping ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_modified_file ` | FilesStatus | Adds a file the modified list of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_node ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_node ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_object_type ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_piece ` | TransferAPI_FileInfo | Adds a piece. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_post_transform ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_prefix ` | ModuleMemberDoc | Adds a prefix (for the documentation). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_role ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_role ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_role_to_domain ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | HTMLTranslatorWithCustomDirectives | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | LatexTranslatorWithCustomDirectives | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | MDTranslatorWithCustomDirectives | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | RSTTranslatorWithCustomDirectives | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | _AdditionalVisitDepart | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_source_parser ` | MockSphinxApp | Registers a parser for a specific file extension. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_tag_slide ` | NotebookRunner | Tries to add tags for a slide show when they are too few. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_text ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_text ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_text ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_text ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_transform ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`adjust_scheduler ` | JenkinsExt | Adjusts the scheduler to avoid having two jobs starting at the same time, jobs are delayed by an hour, two hours, ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`align ` | ImageDirective | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`append ` | _BodyPlaceholder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`appendCommentLine ` | Doxypy | Appends a comment line. The comment delimiter is removed from multiline start and ends as well as singleline ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`appendDefclassLine ` | Doxypy | Appends a line to the triggering block. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`appendFileheadLine ` | Doxypy | Appends a line in the FILEHEAD state. Closes the open comment block, resets it and appends the current line. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`appendNormalLine ` | Doxypy | Appends a line to the output. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`apply_post_transforms ` | _CustomBuildEnvironment | Apply all post-transforms. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`as_dict ` | ProfileNode | Renders the results of a profiling interpreted with function @fn profile2graph. It can then be loaded with ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | MemoryDocTreeBuilder | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | MemoryHTMLBuilder | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | MemoryLatexBuilder | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | MemoryMDBuilder | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | MemoryRSTBuilder | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | _MemoryBuilder | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_toc_fignumbers ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_toc_secnumbers ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertCallable ` | ExtTestCase | Checks that *fct* is callable. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEmpty ` | ExtTestCase | Checks that *x* is empty. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEndsWith ` | ExtTestCase | Checks that string *sub* ends with *whole*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqual ` | ExtTestCase | Checks that ``a == b``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqualArray ` | ExtTestCase | Checks that two arrays are equal. Relies on :epkg:`numpy:testing:assert_almost_equal`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqualDataFrame ` | ExtTestCase | Checks that two dataframes are equal. Calls :epkg:`pandas:testing:assert_frame_equal`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqualDict ` | ExtTestCase | Checks that ``a == b``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqualFloat ` | ExtTestCase | Checks that ``abs(a-b) < precision``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqualNumber ` | ExtTestCase | Checks that two numbers are equal. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertEqualSparseArray ` | ExtTestCase | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertExists ` | ExtTestCase | Checks that *name* exists. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertGreater ` | ExtTestCase | Checks that ``x >= y``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertHasNoNan ` | ExtTestCase | Checks that there is no NaN in ``a``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertIn ` | ExtTestCase | Checks that substring *sub* is in *text*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertLesser ` | ExtTestCase | Checks that ``x <= y``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertLogging ` | ExtTestCase | Returns the logged information in a logger defined by its name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotEmpty ` | ExtTestCase | Checks that *x* is not empty. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotEndsWith ` | ExtTestCase | Checks that string *sub* does not end with *whole*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotEqual ` | ExtTestCase | Checks that ``a != b``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotEqualArray ` | ExtTestCase | Checks that two arrays are equal. Relies on :epkg:`numpy:testing:assert_almost_equal`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotEqualDataFrame ` | ExtTestCase | Checks that two dataframes are different. Calls :epkg:`pandas:testing:assert_frame_equal`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotExists ` | ExtTestCase | Checks that *name* does not exist. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertNotStartsWith ` | ExtTestCase | Checks that string *sub* does not start with *whole*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertRaise ` | ExtTestCase | Checks that function *fct* with no parameter raises an exception of a given type. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertStartsWith ` | ExtTestCase | Checks that string *sub* starts with *whole*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`assertWarning ` | ExtTestCase | Returns the list of warnings raised while executing function *fct*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`base_visit_image ` | CommonSphinxWriterHelpers | Processes an image. By default, it writes the image on disk. Inspired from `visit_image `_ ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`begin_test ` | StringIOAndFile | Redirects output to a :epkg:`*py:io:StringIO`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`bench ` | BenchMark | Runs the benchmark. Overwrite this method. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`bench ` | GridBenchMark | Runs an experiment multiple times, parameter *di* is the dataset to use. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`bench_experiment ` | GridBenchMark | function to overload | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`build_members ` | AutoSignatureDirective | Extracts methods of a class and document them. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`build_parameters_list ` | AutoSignatureDirective | Builds the list of parameters. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`build_summary ` | AutoSignatureDirective | Extracts the part of the docstring before the parameters. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`capture ` | ExtTestCase | Runs a function and capture standard output and error. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`catchall ` | Doxypy | The catchall-condition, always returns true. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`cell_height ` | NotebookRunner | Approximates the height of a cell by its number of lines it contains. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`cell_image ` | NotebookRunner | Returns the cell image or None if not found. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`cell_metadata ` | NotebookRunner | Returns the cell metadata. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`cell_type ` | NotebookRunner | Returns the cell type. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`check_attr ` | DownloadLinkFileCollector | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`clean_code ` | NotebookRunner | Cleans the code before running it, the function comment out instruction such as ``show()``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`cleanup ` | CustomSphinxApp | do some cleanup | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`clear_doc ` | DownloadLinkFileCollector | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close ` | TransferFTP | Closes the connection. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close ` | MockTransferFTP | does noting | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close ` | TransferAPIFtp | close the connection | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close ` | LogFakeFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close ` | LogFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close ` | StringIOAndFile | Calls two close. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`close_stream ` | FolderTransferFTP | Closes a stream opened by :meth:`preprocess_before_transfering`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`codediff ` | MagicDiff | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`compress ` | EncryptedBackup | compress data | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`compress ` | MagicCompress | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect ` | TransferAPIFtp | connect | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | DocTreeWriterWithCustomDirectives | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | HTMLWriterWithCustomDirectives | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | LatexWriterWithCustomDirectives | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | MDWriterWithCustomDirectives | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | RSTWriterWithCustomDirectives | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | _WriterWithCustomDirectives | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`copy ` | NotebookRunner | Copies the notebook (just the content). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`copy ` | DropDownWidget | calls deepcopy | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`copy ` | RadioWidget | calls deepcopy | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`copy ` | RangeWidget | calls deepcopy | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`copy ` | StaticWidget | calls deepcopy | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`copy_to ` | FileTreeNode | Copies the file to *path*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`count_code_cells ` | NotebookRunner | Returns the number of code cells in the notebook. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_builder ` | _CustomSphinx | Creates a builder, raises an exception if name is None. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_job_template ` | JenkinsExt | Adds a job to the :epkg:`Jenkins` server. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_picture_from ` | NotebookRunner | Creates a picture from text. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | MemoryDocTreeBuilder | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | MemoryHTMLBuilder | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | MemoryLatexBuilder | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | MemoryMDBuilder | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | MemoryRSTBuilder | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | _MemoryBuilder | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`cwd ` | TransferFTP | Goes to a directory, if it does not exist, creates it (if *create* is True). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`debug ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`decompress ` | EncryptedBackup | decompress data | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`decrypt_file ` | MagicCrypt | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`default_filters ` | UpgradedRSTExporter | Overrides in subclasses to provide extra filters. This should return an iterable of 2-tuples: (name, class-or-function). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`delete_all_jobs ` | JenkinsExt | Deletes all jobs permanently. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`delete_job ` | JenkinsExt | Deletes :epkg:`Jenkins` job permanently. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_CodeNode ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_CodeNode ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_Text ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_Text ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_Text ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_abbreviation ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_abbreviation ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_attribution ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_attribution ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_bigger_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_block_quote ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_bullet_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_bullet_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_caption ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_caption ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_centered ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_centered ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_citation ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_citation ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_classifier ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_classifier ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_collapse_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_compact_paragraph ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_compact_paragraph ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_compound ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_compound ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition_list_item ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition_list_item ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_addname ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_addname ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_annotation ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_annotation ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_content ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_content ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_name ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_name ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_optional ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_optional ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_parameterlist ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_parameterlist ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_returns ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_returns ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_signature ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_signature ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_type ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_type ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_description ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_description ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_doctest_block ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_doctest_block ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_document ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_document ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_document ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_download_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_download_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_downloadlink_node ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_downloadlink_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_emphasis ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_emphasis ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_entry ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_entry ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_enumerated_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_enumerated_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_body ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_body ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_name ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_name ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_figure ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_figure ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_footnote ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_footnote ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_gdot_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_generated ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_generated ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_gitlog_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_glossary ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_glossary ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_hlist ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_hlist ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_hlistcol ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_hlistcol ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_image ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_image ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_image_node_fallback ` | Backend | translator method | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_image_node_html ` | LightBox2 | translator method | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_imgsgnode ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_imgsgnode ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_imgsgnode ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inheritance_diagram ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inheritance_diagram ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inheritance_diagram ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inline ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inline ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_issue ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_issue ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_line ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_line ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_line_block ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_line_block ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_list_item ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_list_item ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal_block ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal_block ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal_emphasis ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal_emphasis ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | LatexTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | MDTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | RSTTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_argument ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_argument ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_group ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_group ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_list_item ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_list_item ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_string ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_string ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_paragraph ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_paragraph ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_pending_xref ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_pending_xref ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_problematic ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_problematic ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_quote_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_refcount ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_refcount ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_row ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_row ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_rubric ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_rubric ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_runpythonthis_node ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_runpythonthis_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_section ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_section ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_seealso ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_seealso ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_sharenet_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_simpleimage ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_simpleimage ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_strong ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_strong ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_subscript ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_subscript ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_subtitle ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_subtitle ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_superscript ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_superscript ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_table ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_table ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_target ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_tbody ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_tbody ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_term ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_term ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_tgroup ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_tgroup ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_thead ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_thead ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_title ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_title ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_title_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_title_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_todo_node ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_todo_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_topic ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_topic ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_topic ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_topic ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_versionmodified ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | LatexTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | MDTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | RSTTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`difference ` | FileTreeNode | Returns the differences with another folder. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`difference ` | FilesStatus | Goes through the list of files and tells which one has changed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`difftext ` | MagicDiff | Defines ``%difftext`` which calls :meth:`textdiff `. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`dir ` | TransferFTP | Lists the content of a path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`disconnect_env_collector ` | _CustomSphinx | Disables a collector given its class name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`disconnect_env_collector ` | MockSphinxApp | Disconnects a collector given its class name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`do_GET ` | DocumentationHandler | What to do is case of GET request. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`do_POST ` | DocumentationHandler | What to do is case of POST request. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`do_redirect ` | DocumentationHandler | Redirection when url is just the website. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`emit ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`emit_firstresult ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`enable ` | CustomTocTreeCollector | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`encrypt_file ` | MagicCrypt | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`end ` | BenchMark | Cleans. Overwrites this method. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`end_state ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`end_state ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`end_state ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`end_test ` | StringIOAndFile | Ends the redirection. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate ` | SqlLite3FileStore | Queries the database, enumerates the results. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_content ` | SqlLite3FileStore | Queries the database, enumerates the results, returns the content as well. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_data ` | SqlLite3FileStore | Queries the database, enumerates the results. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_ls ` | TransferFTP | Enumerates the content of a path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_read_encrypt ` | EncryptedBackup | enumerate pieces of files as bytes | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eof ` | _AsyncLineReader | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval ` | MagicCommandParser | Evaluate a string knowing the context, it returns *value* if it does not belong to the context or if it ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | LatexTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | MDTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | RSTTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`exists ` | FileTreeNode | say if it does exist or not | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`expected_eval_type ` | MagicCommandParser | return the expected evaluation type for the parameter (if the value is interpreter as a python expression) | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`expected_type ` | MagicCommandParser | Returns the expected type for the parameter. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`extract_requirements ` | JenkinsExt | Extracts the requirements for a job. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fLOG ` | BenchMark | Logs something. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fLOG ` | CustomLog | Builds a message on a single line with the date, it deals with encoding issues. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fLOG ` | ExtTestCase | Prints out some information. :func:`fLOG`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`feed ` | DocumentationHandler | Displays something. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fill_node ` | BlogPostDirective | Fills the content of the node. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fill_node ` | BlogPostDirectiveAgg | Fill the node of an aggregated page. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finalize ` | _CustomSphinx | Finalizes the documentation after it was parsed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finalize ` | MockSphinxApp | Finalizes the documentation after it was parsed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finish ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finish ` | DocTreeBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finish ` | EnhancedLaTeXBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finish ` | MdBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`finish ` | RstBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`first_cell ` | NotebookRunner | Returns the first cell. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | MemoryDocTreeBuilder | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | MemoryHTMLBuilder | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | MemoryLatexBuilder | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | MemoryMDBuilder | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | MemoryRSTBuilder | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | _MemoryBuilder | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`flush ` | LogFakeFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`flush ` | LogFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`flush ` | StringIOAndFile | Calls two flush. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`fprint ` | BufferedPrint | print function | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get ` | FileTreeNode | return a dictionary with some values which describe the file | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_args ` | MagicClassWithHelpers | parser a command line with a given parser | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_categories ` | BlogPostList | Extracts the categories. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_categories_group ` | BlogPostList | Extracts the categories with the posts associated to it. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_cmd_standalone ` | JenkinsExt | Custom command for :epkg:`Jenkins` (such as updating conda) | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_content ` | FileTreeNode | Returns the content of a text file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_default_values ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_description ` | NotebookRunner | Gets summary and description of this notebook. We expect the first cell to contain a title and a description ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_dict ` | FileTreeNode | Returns a dictionary ``{ self._file : node }``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_doc_context ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_doctree ` | _CustomBuildEnvironment | Read the doctree for a file from the pickle and return it. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_engine_from_job ` | JenkinsExt | Extracts the engine from the job definition, it should be like ``[engine]``. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_file_content ` | DocumentationHandler | Returns the content of a local file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_files ` | BlogPostList | Extracts the files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_fullname ` | FileTreeNode | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_image ` | BlogPostList | Returns the local path to an image in this folder. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_jenkins_job_name ` | JenkinsExt | Infers a name for the jenkins job. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_jenkins_script ` | JenkinsExt | Builds the :epkg:`Jenkins` script for a module and its options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_jobs ` | JenkinsExt | Gets the list of all jobs recursively to the given folder depth, see `get_all_jobs `_. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_keywords ` | BlogPostList | Extracts the categories. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_last_commit_hash ` | SourceRepository | Returns the last commit. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_months ` | BlogPostList | Extracts the months. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_months_group ` | BlogPostList | Extracts the months with the posts associated to it. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outdated_docs ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outdated_docs ` | DocTreeBuilder | Return an iterable of input files that are outdated. This method is taken from ``TextBuilder.get_outdated_docs()`` ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outdated_docs ` | MdBuilder | Return an iterable of input files that are outdated. This method is taken from ``TextBuilder.get_outdated_docs()`` ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outdated_docs ` | RstBuilder | Return an iterable of input files that are outdated. This method is taken from ``TextBuilder.get_outdated_docs()`` ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | MemoryDocTreeBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | MemoryHTMLBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | MemoryLatexBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | MemoryMDBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | MemoryRSTBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | _MemoryBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | DocTreeBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | EnhancedLaTeXBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | MdBuilder | Overwrite *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | RstBuilder | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_parser ` | MagicClassWithHelpers | Returns a parser for a magic command, initializes it if it does not exists, it creates it. The parsers are stored ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_projects ` | GitLabAPI | returns a list of dictionaries | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_relative_uri ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_remote_path ` | MockTransferAPI | Produces a remote path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_remote_path ` | TransferAPI | Produces a remote path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_root ` | ProfileNode | Returns the root of the graph. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_rst_links_down ` | BlogPostList | Builds the :epkg:`rst` links to months or categories to displays the bottom of the aggregated pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_rst_links_up ` | BlogPostList | Builds the :epkg:`rst` links to months or categories to displays at the beginning of the aggregated pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | MemoryDocTreeBuilder | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | MemoryHTMLBuilder | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | MemoryLatexBuilder | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | MemoryMDBuilder | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | MemoryRSTBuilder | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | _MemoryBuilder | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | DocTreeBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | MdBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | RstBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_thumbnail ` | NotebookRunner | Processes the notebook and creates one picture based on the outputs to illustrate a notebook. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`getvalue ` | StringIOAndFile | Returns the content of the buffer. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`graphs ` | BenchMark | Builds graphs after the benchmark was run. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | MemoryDocTreeBuilder | Override *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | MemoryHTMLBuilder | Overrides *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | MemoryLatexBuilder | Overrides *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | MemoryMDBuilder | Override *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | MemoryRSTBuilder | Override *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | _MemoryBuilder | Overrides *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | DocTreeBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | MdBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | RstBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`has_been_modified_and_reason ` | FilesStatus | Returns *(True, reason)* if a file was modified or *(False, None)* if not. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`has_choices ` | MagicCommandParser | tells if a parameter has choises | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`has_eval ` | MagicCommandParser | Tells if a parameter value should be consider as a variable or some python code to evaluate. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`hash_md5_readfile ` | FileTreeNode | Computes a hash of a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`hash_md5_readfile ` | CommonSphinxWriterHelpers | Computes a hash of a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`html ` | StaticInteract | Produce the HTML output, insert results from :meth:`_output_html` and :meth:`_widget_html` and insert it into the ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`html ` | DropDownWidget | return HTML string | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`html ` | RadioWidget | return HTML string | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`html ` | RangeWidget | HTML code | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`html ` | StaticWidget | abstract method | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`htmlhelp ` | MagicClassExample | Defines ``%htmlhelp``, it displays the help for an object in :epkg:`HTML`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`info ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`init ` | BenchMark | Initialisation. Overwrite this method. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`init ` | GridBenchMark | Skips it. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`init ` | DocTreeBuilder | Load necessary templates and perform initialization. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`init ` | MdBuilder | Load necessary templates and perform initialization. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`init ` | RstBuilder | Load necessary templates and perform initialization. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`init_main ` | GridBenchMark | initialisation | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | HTMLTranslatorWithCustomDirectives | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | LatexTranslatorWithCustomDirectives | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | MDTranslatorWithCustomDirectives | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | RSTTranslatorWithCustomDirectives | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | _AdditionalVisitDepart | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | HTMLTranslatorWithCustomDirectives | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | LatexTranslatorWithCustomDirectives | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | MDTranslatorWithCustomDirectives | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | RSTTranslatorWithCustomDirectives | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | _AdditionalVisitDepart | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | HTMLTranslatorWithCustomDirectives | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | LatexTranslatorWithCustomDirectives | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | MDTranslatorWithCustomDirectives | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | RSTTranslatorWithCustomDirectives | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | _AdditionalVisitDepart | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | HTMLTranslatorWithCustomDirectives | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | LatexTranslatorWithCustomDirectives | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | MDTranslatorWithCustomDirectives | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | RSTTranslatorWithCustomDirectives | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | _AdditionalVisitDepart | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_remote ` | ImageDirective | local function | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | HTMLTranslatorWithCustomDirectives | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | LatexTranslatorWithCustomDirectives | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | MDTranslatorWithCustomDirectives | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | RSTTranslatorWithCustomDirectives | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | _AdditionalVisitDepart | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`isdir ` | FileTreeNode | is it a folder? | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`isfile ` | FileTreeNode | is it a file? | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_cells ` | NotebookRunner | Iterates over the notebook cells. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_code_cells ` | NotebookRunner | Iterates over the notebook cells containing code. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_eligible_files ` | EncryptedBackup | iterates on eligible file for transfering (if they have been modified) | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_eligible_files ` | FolderTransferFTP | Iterates on eligible file for transfering (if they have been modified). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_modified ` | FilesStatus | Iterates on all modified files yield a couple *(filename, reason)*. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | MemoryDocTreeBuilder | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | MemoryHTMLBuilder | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | MemoryLatexBuilder | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | MemoryMDBuilder | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | MemoryRSTBuilder | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | _MemoryBuilder | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`jenkins_open ` | JenkinsExt | Overloads the same method from module :epkg:`python-jenkins` to replace string by bytes. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`latex_image_length ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`load_mapping ` | EncryptedBackup | retrieves existing mapping | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`log ` | SourceRepository | Gets the latest changes operated on a file in a folder or a subfolder. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`log_unknown ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`log_unknown ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`log_unknown ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`login ` | GitLabAPI | login | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`ls ` | TransferFTP | Lists the content of a path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`ls ` | SourceRepository | Extracts the content of a location. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`makeCommentBlock ` | Doxypy | Indents the current comment block with respect to the current indentation level. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`makeTransition ` | FSM | Makes a transition based on the given input. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`max_date ` | FileTreeNode | return the more recent date | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`merge_notebook ` | NotebookRunner | Appends notebook *nb* to this one. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`merge_other ` | DownloadLinkFileCollector | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`meta_to_df ` | BenchMark | Converts meta data into a dataframe | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`mkd ` | TransferFTP | Creates a directory. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`modify_script_before_running ` | RunPythonDirective | Takes the script as a string and returns another string before it is run. It does not modify what is displayed. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`nb_children ` | FileTreeNode | return the number of children | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`nb_commits ` | SourceRepository | Returns the number of commits. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`new_state ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`new_state ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`new_state ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`open ` | WinZipFile | Returns file-like object for 'name'. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`open ` | LogFakeFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`open ` | LogFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`override_transform ` | OverrideDocFieldTransformer | Transform a single field list *node*. Overwrite function `transform `_. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`parse ` | Doxypy | Parses a python file given as input string and returns the doxygen- compatible representation. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`parseFile ` | Doxypy | Parses a :epkg:`python` file given as input string and returns` the :epkg:`doxygen` compatible representation. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`parseLine ` | Doxypy | Parses one line of python and flush the resulting output to the outstream. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`parse_cmd ` | MagicCommandParser | Splits line using `shlex `_ and call `parse_args `_ ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`populate ` | ModuleMemberDoc | Extracts some information about an object. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`post_as_rst ` | BlogPost | Reproduces the text of the blog post, updates the image links. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`predict_score_experiment ` | GridBenchMark | function to overload | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`prepare_writing ` | DocTreeBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`prepare_writing ` | MdBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`prepare_writing ` | RstBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`preprocess_before_transfering ` | FolderTransferFTP | Applies some preprocessing to the file to transfer. It adds the footer for example. It returns a stream ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`preprocess_cell ` | LatexRawOutputPreprocessor | Applies a transformation on each cell. See base.py for details, add ``\begin{verbatim}`` and ``\end{verbatim}``. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`preprocess_dataset ` | GridBenchMark | Splits the dataset into train and test. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`print_list ` | TransferFTP | Returns the list of files in the current directory the function sends everything to the logging function. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`private_run ` | BlocRef | Builds a node :class:`blocref_node`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_doc ` | DownloadLinkFileCollector | Process downloadable file paths. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_doc ` | CustomTocTreeCollector | Build a TOC from the doctree and store it in the inventory. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_options ` | JenkinsExt | Postprocesses a script inserted in a job definition. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`pwd ` | TransferFTP | Returns the pathname of the current directory on the server. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`read ` | open_stream_file | Reads some bytes. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`read_file ` | ExtTestCase | Returns the content of a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`readline ` | open_stream_file | Basic implementation. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`readlines ` | open_stream_file | Basic implementation. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`remove ` | FileTreeNode | Removes the file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`renamed ` | DropDownWidget | rename *name* if *name* is an attribute | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`renamed ` | RadioWidget | rename *name* if *name* is an attribute | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`renamed ` | RangeWidget | rename *name* if *name* is an attribute | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`renamed ` | StaticWidget | rename *name* if *name* is an attribute | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`render ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`repo_ls ` | FileTreeNode | call ls of an instance of :class:`SourceRepository` | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`report ` | BenchMark | Produces a report. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`require_sphinx ` | MockSphinxApp | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`resetCommentSearch ` | Doxypy | Restarts a new comment search for a different triggering line. Closes the current commentblock and starts a new ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | EncryptedBackup | retrieve a backuped file | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | TransferFTP | Downloads a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | MockTransferAPI | Retrieves data from path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | TransferAPI | Retrieves data from path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | TransferAPIFile | Retrieves data from path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | TransferAPIFtp | retrieve data from path | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_all ` | EncryptedBackup | retrieve all backuped files | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_mapping ` | MockTransferAPI | Returns the mapping. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_mapping ` | TransferAPI | Returns the mapping. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`rst_link ` | IndexInformation | return a link rst | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`rst_link ` | ModuleMemberDoc | Returns a sphinx link on the object. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | BenchMark | Runs the benchmark. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | GridBenchMark | Runs the benchmark. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | _AsyncLineReader | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | DocumentationThreadServer | Runs the server. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | RevealjsDirective | build revealjs node | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | RvCodeDirective | build rv_code node | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | RvNoteDirective | build rv_note node | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | RvSmallDirective | build rv_small node | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | AutoSignatureDirective | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | BlocRef | Builds a node :class:`blocref_node`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | BlocRefList | Simply insert an empty blocreflist node which will be replaced later when process_blocref_nodes is called | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | BlogPostDirective | extracts the information in a dictionary and displays it if the environment is not null | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | BlogPostDirectiveAgg | extracts the information in a dictionary and displays it if the environment is not null | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | BlogPostListDirective | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | CmdRef | calls run from :class:`BlocRef` and add index entries by default | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | CmdRefList | calls run from :class:`BlocRefList` and add default tag if not present | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | CollapseDirective | Builds the collapse text. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | ExRef | calls run from :class:`BlocRef` and add defaut tag | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | ExRefList | calls run from :class:`BlocRefList` and add default tag if not present | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | FaqRef | calls run from :class:`BlocRef` and add defaut tag | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | FaqRefList | calls run from :class:`BlocRefList` and add default tag if not present | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | GDotDirective | Builds the collapse text. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | SimpleImageDirective | Runs the directive. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | MathDef | Builds the mathdef text. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | MathDefList | Simply insert an empty mathdeflist node which will be replaced later when process_mathdef_nodes is called | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | NbRef | calls run from :class:`BlocRef` and add index entries by default | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | NbRefList | calls run from :class:`BlocRefList` and add default tag if not present | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | PostContentsDirective | Just add a :class:`postcontents_node`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | QuoteNode | Builds the mathdef text. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | RunPythonDirective | Extracts the information in a dictionary, runs the script. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | ShareNetDirective | Runs the directve. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | TocDelayDirective | Just add a :class:`tocdelay_node` and list the documents to add. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | CustomTocTree | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | TodoExt | builds the todo text | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | TodoExtList | Simply insert an empty todoextlist node which will be replaced later when process_todoext_nodes is called | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | VideoDirective | Runs the directive. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | YoutubeDirective | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | ImageDirective | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_cell ` | NotebookRunner | Runs a notebook cell and update the output of that cell inplace. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_command ` | MockTransferFTP | Mock method :meth:`run_command ` | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_command ` | TransferFTP | Runs a FTP command. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_notebook ` | NotebookRunner | Runs all the cells of a notebook in order and update the outputs in-place. If ``skip_exceptions`` is set, ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`save_dates ` | FilesStatus | Saves the status of the copy. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`send_headers ` | DocumentationHandler | defines the header to send (type of files) based on path | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`serve_content ` | DocumentationHandler | Tells what to do based on the path. The function intercepts the path /localfile/, otherwise it calls ``serve_content_web``. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`serve_content_web ` | DocumentationHandler | Functions to overload (executed after serve_content). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`serve_main_page ` | DocumentationHandler | Displays all the mapping for the default path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`setStartState ` | FSM | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`set_date ` | FileInfo | set date | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`set_md5 ` | FileInfo | set md5 | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`set_mdate ` | FileInfo | set mdate | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`set_rst_file ` | IndexInformation | Sets the rst file and checks the label is present in it. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`setup_extension ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`setup_extension ` | MockSphinxApp | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`setup_jenkins_server ` | JenkinsExt | Sets up many jobs in :epkg:`Jenkins`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`shutdown ` | DocumentationHandler | Shuts down the service. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`shutdown ` | DocumentationThreadServer | Shuts down the server, if it does not work, you can still kill the thread: | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`shutdown_kernel ` | NotebookRunner | Shuts down kernel. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`sign ` | FileTreeNode | Returns ``==``, ``<`` or ``>`` according the dates if the size is not too big, if the sign is ``<`` or ``>``, ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`startCommentSearch ` | Doxypy | Starts a new comment search. Saves the triggering line, resets the current comment and saves the current ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`start_transfering ` | EncryptedBackup | starts transfering files to the remote website | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`start_transfering ` | FolderTransferFTP | Starts transfering files to a remote :epkg:`FTP` website. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`stopCommentSearch ` | Doxypy | Stops a comment search. Closes the current commentblock, resets the triggering line and appends the current ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`strdiff ` | MagicDiff | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`submit ` | SqlLite3FileStore | Submits a file to the database. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`submit_data ` | SqlLite3FileStore | Submits data to the database. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`suffix_label ` | BlogPostDirective | returns a suffix to add to a label, it should not be empty for aggregated pages | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`suffix_label ` | BlogPostDirectiveAgg | returns a suffix to add to a label, it should not be empty for aggregated pages | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`textdiff ` | MagicDiff | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`to_df ` | BenchMark | Converts the metrics into a dataframe. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`to_json ` | TransferAPI_FileInfo | Serializes this class info JSON. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`to_json ` | NotebookRunner | Converts the notebook into :epkg:`JSON`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`to_json ` | ProfileNode | Renders the results of a profiling interpreted with function @fn profile2graph as :epkg:`JSON`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`to_python ` | NotebookRunner | Converts the notebook into python. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`to_text ` | ProfileNode | Prints the profiling to text. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | EncryptedBackup | transfer data | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | TransferFTP | Transfers a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | MockTransferFTP | does nothing, returns True | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | MockTransferAPI | It assumes a data holds in memory, tansfer data to path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | TransferAPI | It assumes a data holds in memory, tansfer data to path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | TransferAPIFile | It assumes a data holds in memory, tansfer data to path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | TransferAPIFtp | It assumes a data holds in memory, tansfer data to path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer_mapping ` | EncryptedBackup | transfer the mapping | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer_mapping ` | MockTransferAPI | Transfers the mapping. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`transfer_mapping ` | TransferAPI | Transfers the mapping. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | DocTreeWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | HTMLWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | LatexWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | MDWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | RSTWriterWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | DocTreeWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | EnhancedLaTeXWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | MdWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | RstWriter | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`uncache ` | BenchMark | overwrite this method to uncache some previous run | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_departure ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_departure ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | LatexTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | MDTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | RSTTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`update_copied_file ` | FilesStatus | Updates the file in copyFiles (before saving), update all fields. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`update_mapping ` | EncryptedBackup | update the status of a file | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`update_status ` | EncryptedBackup | update the status of a file | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`update_status ` | FolderTransferFTP | Updates the status of a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`values ` | DropDownWidget | return all possible values | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`values ` | RadioWidget | return all the possible values | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`values ` | RangeWidget | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`version ` | SourceRepository | Gets the latest check in number for a specific path. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_CodeNode ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_CodeNode ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_Text ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_Text ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_Text ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_abbreviation ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_abbreviation ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_acks ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_acks ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_admonition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_admonition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_attribution ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_attribution ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_bigger_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_block_quote ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_bullet_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_bullet_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_caption ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_caption ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_centered ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_centered ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_citation ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_citation ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_citation_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_citation_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_classifier ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_classifier ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_collapse_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_colspec ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_colspec ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_comment ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_comment ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_compact_paragraph ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_compact_paragraph ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_compound ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_compound ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition_list_item ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition_list_item ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_addname ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_addname ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_annotation ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_annotation ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_content ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_content ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_name ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_name ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_optional ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_optional ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_parameter ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_parameter ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_parameterlist ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_parameterlist ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_returns ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_returns ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_signature ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_signature ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_type ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_type ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_description ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_description ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_doctest_block ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_doctest_block ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_document ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_document ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_document ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_document ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_download_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_download_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_downloadlink_node ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_downloadlink_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_emphasis ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_emphasis ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_entry ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_entry ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_enumerated_list ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_enumerated_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_enumerated_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_body ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_body ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_name ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_name ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_figure ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_figure ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_footnote ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_footnote ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_footnote_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_footnote_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_gdot_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_generated ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_generated ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_gitlog_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_glossary ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_glossary ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_highlightlang ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_highlightlang ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_hlist ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_hlist ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_hlistcol ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_hlistcol ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_image ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_image ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_image_node_fallback ` | Backend | translator method | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_image_node_html ` | LightBox2 | translator method | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_imgsgnode ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_imgsgnode ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_imgsgnode ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_index ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_index ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inheritance_diagram ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inheritance_diagram ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inheritance_diagram ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inline ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inline ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_issue ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_issue ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_label ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_label ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_line ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_line ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_line_block ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_line_block ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_list_item ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_list_item ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal_block ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal_block ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal_emphasis ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal_emphasis ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_meta ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_meta ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | LatexTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | MDTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | RSTTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | EnhancedLaTeXTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_argument ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_argument ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_group ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_group ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_list ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_list ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_list_item ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_list_item ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_string ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_string ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_paragraph ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_paragraph ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_pending_xref ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_pending_xref ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_pending_xref ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_problematic ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_problematic ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_productionlist ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_productionlist ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_quote_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_raw ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_raw ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_refcount ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_refcount ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_reference ` | RstTranslator | Runs upon entering a reference. Because this class inherits from the TextTranslator class, regularly defined ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_row ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_row ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_rubric ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_rubric ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_runpythonthis_node ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_runpythonthis_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_section ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_section ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_seealso ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_seealso ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_sharenet_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_simpleimage ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_simpleimage ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_strong ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_strong ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_subscript ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_subscript ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_substitution_definition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_substitution_definition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_subtitle ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_subtitle ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_superscript ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_superscript ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_system_message ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_system_message ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_table ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_table ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tabular_col_spec ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tabular_col_spec ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_target ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_target ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tbody ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tbody ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_term ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_term ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_termsep ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_termsep ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tgroup ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tgroup ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_thead ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_thead ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_title ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_title ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_title_reference ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_title_reference ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_todo_node ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_todo_node ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_topic ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_topic ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_topic ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_topic ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_transition ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_transition ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_versionmodified ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | HTMLTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | LatexTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | MDTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | RSTTranslatorWithCustomDirectives | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | _AdditionalVisitDepart | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`warning ` | _CustomSphinx | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`wrap ` | DocTreeTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`wrap ` | MdTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`wrap ` | RstTranslator | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | CustomSingleFileHTMLBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | DocTreeWriterWithCustomDirectives | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | HTMLWriterWithCustomDirectives | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | LatexWriterWithCustomDirectives | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | MDWriterWithCustomDirectives | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | RSTWriterWithCustomDirectives | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | _WriterWithCustomDirectives | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | LogFakeFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | LogFileStream | does nothing | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | StringIOAndFile | Appends a string. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | CustomizedSphinxFileOutput | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | EnhancedLaTeXBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated ` | BlogPostList | Writes posts in a aggregated manner (post, categories, months). | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_categories ` | BlogPostList | Writes posts in a aggregated manner per categories. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_chapters ` | BlogPostList | Writes links to post per categories and per months. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_index ` | BlogPostList | Writes an index. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_months ` | BlogPostList | Writes posts in a aggregated manner per months. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_posts ` | BlogPostList | Writes posts in a aggregated manner. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_doc ` | DocTreeBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_doc ` | MdBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_doc ` | RstBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_file ` | ExtTestCase | Writes the content of a file. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_stylesheet ` | MemoryLatexBuilder | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+