Methods

Summary

method

class parent

truncated documentation

LOG

DocumentationHandler

logging function

SetGuessedType

SourceRepository

Guesses the repository type given a location and changes a member of the class.

__add__

NotebookRunner

Merges two notebooks together, returns a new none.

__call__

CustomLog

Log anything.

__closeComment

Doxypy

Appends any open comment block and triggering block to the output.

__cmp__

ModuleMemberDoc

Comparison operators, compares first the first, second the name (lower case).

__cmp__

BlogPost

This method avoids to get the following error TypeError: unorderable types: BlogPost() < BlogPost().

__del__

NotebookRunner

We close the kernel.

__del__

CustomLog

Closes the stream if needed.

__docstringSummaryToBrief

Doxypy

Adds brief to the docstrings summary line. A brief is prepended, provided no other doxygen command is at the …

__enter__

open_stream_file

Opens the stream or the file.

__enter__

python_path_append

Modifies os.environ['PYTHONPATH'].

__enter__

sys_path_append

Modifies sys.path.

__eq__

ModuleMemberDoc

Operator ==.

__exit__

open_stream_file

Leaves the stream or the filename.

__exit__

python_path_append

Restores``sys.path``.

__exit__

sys_path_append

Restores``sys.path``.

__flushBuffer

Doxypy

Flushes the current outputbuffer to the outstream.

__getitem__

FileTreeNode

returns the element i

__getitem__

BlogPostList

usual

__gt__

ModuleMemberDoc

Operator >.

__init__

BenchMark

__init__

GridBenchMark

initialisation

__init__

EncryptedBackup

constructor

__init__

FileInfo

constructor

__init__

FileTreeNode

Defines a file, relative to a root.

__init__

FilesStatus

file which will contains the status

__init__

MockTransferFTP

constructor

__init__

TransferFTP

constructor

__init__

FolderTransferFTP

__init__

MockTransferFTP

same signature as TransferFTP

__init__

MockTransferAPI

constructor

__init__

TransferAPI

constructor

__init__

TransferAPI_FileInfo

information about a transferred file

__init__

TransferAPIFile

constructor

__init__

TransferAPIFtp

constructor

__init__

Doxypy

Constructor for Doxypy.

__init__

FSM

__init__

Opt

__init__

LatexRawOutputPreprocessor

Overloads the constructor.

__init__

HelpGenException

redefines the message sent to an exception

__init__

UpgradedRSTExporter

Overwrites the extra loaders to get the right template.

__init__

SphinxVerificationException

__init__

DocTreeTranslatorWithCustomDirectives

constructor

__init__

DocTreeWriterWithCustomDirectives

__init__

HTMLTranslatorWithCustomDirectives

__init__

HTMLWriterWithCustomDirectives

__init__

LatexTranslatorWithCustomDirectives

constructor

__init__

LatexWriterWithCustomDirectives

__init__

MDTranslatorWithCustomDirectives

constructor

__init__

MDWriterWithCustomDirectives

__init__

MemoryDocTreeBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

__init__

MemoryHTMLBuilder

Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). …

__init__

MemoryLatexBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

__init__

MemoryMDBuilder

Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). …

__init__

MemoryRSTBuilder

Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). …

__init__

RSTTranslatorWithCustomDirectives

constructor

__init__

RSTWriterWithCustomDirectives

__init__

_AdditionalVisitDepart

__init__

_CustomBuildEnvironment

__init__

_CustomSphinx

Same constructor as Sphinx application. Additional parameters:

__init__

CustomSphinxApp

__init__

MockSphinxApp

__init__

useless_class_UnicodeStringIOThreadSafe

creates a lock

__init__

IndexInformation

__init__

ModuleMemberDoc

__init__

RstFileHelp

__init__

StaticInteract

constructor

__init__

AutoCompletion

constructor

__init__

AutoCompletionFile

constructor

__init__

MagicCommandParser

custom constructor, see argparse.ArgumentParser.

__init__

NotebookRunner

constuctor

__init__

DropDownWidget

__init__

RadioWidget

constructor

__init__

RangeWidget

constructor

__init__

StaticWidget

constructor

__init__

JenkinsExt

__init__

BufferedPrint

constructor

__init__

CustomLog

initialisation

__init__

FlogStatic

constructor

__init__

LogFakeFileStream

does nothing

__init__

LogFileStream

creates a logger

__init__

GitHubApiException

Merges everything into a string.

__init__

open_stream_file

__init__

PQHException

constructor

__init__

SourceRepository

__init__

GitLabAPI

constructor

__init__

GitLabException

__init__

RepoFile

__init__

RepoFile

constructor

__init__

_AsyncLineReader

__init__

python_path_append

__init__

sys_path_append

__init__

PQPipError

constructor

__init__

TestExecutionError

__init__

StringIOAndFile

constructor

__init__

DocumentationHandler

Regular constructor, an instance is created for each request, do not store any data for a longer time than a request. …

__init__

DocumentationThreadServer

__init__

BlogPost

Creates an instance of a blog post from a file or a string.

__init__

BlogPostList

Creates a list of BlogPost, we assume each blog post belongs to a subfolder YYYY.

__init__

OverrideDocFieldTransformer

Constructor

__init__

DocTreeBuilder

Constructor, add a logger.

__init__

DocTreeTranslator

__init__

DocTreeWriter

__init__

ClassStruct

All arguments are added to the class.

__init__

NodeEnter

Create a note

__init__

NodeLeave

Create a note

__init__

TinyNode

Create a note

__init__

WrappedNode

__init__

CustomizedSphinxFileOutput

__init__

EnhancedLaTeXBuilder

Constructor, add a logger.

__init__

EnhancedLaTeXTranslator

__init__

EnhancedLaTeXWriter

__init__

MdBuilder

Constructor, add a logger.

__init__

MdTranslator

__init__

MdWriter

__init__

RstBuilder

Constructor, add a logger.

__init__

RstTranslator

__init__

RstWriter

__init__

ClassStruct

All arguments are added to the class.

__init__

Backend

__iter__

FileTreeNode

iterator on the element

__iter__

FilesStatus

Iterates on all files stored in the current file, yield a couple (filename, FileInfo).

__iter__

BlogPostList

Iterates on BlogPost.

__len__

FileTreeNode

Returns the number of elements in this folder and in the subfolders.

__len__

AutoCompletion

returns the number of elements

__len__

AutoCompletionFile

returns the number of elements

__len__

NotebookRunner

Returns the number of cells, it iterates on cells to get this information and does cache the information.

__len__

BlogPostList

Returns the number of blog posts.

__lt__

ModuleMemberDoc

Operator <.

__lt__

BlogPost

Tells if this blog should be placed before other.

__repr__

DropDownWidget

operator, call method html

__repr__

RadioWidget

operator, call method html

__repr__

RangeWidget

operator, call method html

__repr__

StaticWidget

operator, call method html

__str__

FileInfo

usual

__str__

FileTreeNode

usual

__str__

FolderTransferFTP

usual

__str__

TransferAPI_FileInfo

usual

__str__

CustomSphinxApp

usual

__str__

IndexInformation

usual

__str__

ModuleMemberDoc

usual

__str__

AutoCompletion

returns a string

__str__

AutoCompletionFile

returns a string

__str__

BufferedPrint

Returns the content.

__str__

GitLabException

usual

__str__

RepoFile

usual

__str__

RepoFile

usual

_add

AutoCompletion

add a member to this class, add an AutoCompletion instance, creates one if value is not from AutoCompletion

_add

AutoCompletionFile

add a member to this class, add an AutoCompletion instance, creates one if value is not from AutoCompletion

_add_missing_element_in_config

CustomSphinxApp

Adds extra elements in config such as latex_elements.

_cell_container

NotebookRunner

Returns a cells container, it may change according to the format.

_check_thumbnail_tuple

NotebookRunner

Checks types for a thumbnail.

_convert

BenchMark

Converts a value knowing its column, its type into something readable.

_extended_init_

_CustomSphinx

Additional initialization steps.

_fill

FileTreeNode

look for subfolders

_fillstat

FileTreeNode

private: fill _type, _size

_filter

AutoCompletionFile

remove unexpected characters for a file name

_format_obj

DocTreeTranslator

_get_filename

MemoryLatexBuilder

_get_filename

EnhancedLaTeXBuilder

_init

DocTreeWriterWithCustomDirectives

_init

HTMLWriterWithCustomDirectives

_init

LatexWriterWithCustomDirectives

_init

MDWriterWithCustomDirectives

_init

MemoryDocTreeBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

_init

MemoryHTMLBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

_init

MemoryLatexBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

_init

MemoryMDBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

_init

MemoryRSTBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

_init

RSTWriterWithCustomDirectives

_init

_MemoryBuilder

Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten …

_init

_WriterWithCustomDirectives

_init_env

_CustomSphinx

_lookup_doctree

_CustomSphinx

_merge_images

NotebookRunner

Merges images defined by (buffer, format). The method uses PIL to merge images when possible.

_output_html

StaticInteract

html output

_populate

AutoCompletionFile

populate the class with files and folder in the folder this class holds

_private_login

TransferFTP

logs in

_repr_html_

StaticInteract

Synonym for html.

_repr_html_

DropDownWidget

operator, call method html

_repr_html_

RadioWidget

operator, call method html

_repr_html_

RangeWidget

operator, call method html

_repr_html_

StaticWidget

operator, call method html

_scale_image

NotebookRunner

Scales an image with the same aspect ratio centered in an image with a given max_width and max_height.

_setup_jenkins_server_job_iteration

JenkinsExt

_setup_jenkins_server_modules_loop

JenkinsExt

_single_option

DropDownWidget

private

_single_radio

RadioWidget

private

_update_link

BlogPost

Changes a link to an image if the page contains one into year/img.png.

_update_title

BlocRef

Updates the title for the bloc itself.

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

MdTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_visit_admonition

RstTranslator

_widget_html

StaticInteract

_write_parallel

MemoryDocTreeBuilder

Not supported.

_write_parallel

MemoryHTMLBuilder

Not supported.

_write_parallel

MemoryLatexBuilder

Not supported.

_write_parallel

MemoryMDBuilder

Not supported.

_write_parallel

MemoryRSTBuilder

Not supported.

_write_parallel

_MemoryBuilder

Not supported.

_write_serial

MemoryDocTreeBuilder

Overwrites _write_serial to avoid writing on disk.

_write_serial

MemoryHTMLBuilder

Overwrites _write_serial to avoid writing on disk.

_write_serial

MemoryLatexBuilder

Overwrites _write_serial to avoid writing on disk.

_write_serial

MemoryMDBuilder

Overwrites _write_serial to avoid writing on disk.

_write_serial

MemoryRSTBuilder

Overwrites _write_serial to avoid writing on disk.

_write_serial

_MemoryBuilder

Overwrites _write_serial to avoid writing on disk.

addTransition

FSM

add_argument

MagicCommandParser

Overloads the method, see ArgumentParser. Among the …

add_autodocumenter

MockSphinxApp

See class Sphinx.

add_builder

_CustomSphinx

add_builder

MockSphinxApp

See class Sphinx.

add_config_value

_CustomSphinx

add_config_value

MockSphinxApp

See class Sphinx.

add_configuration_options

DocTreeWriterWithCustomDirectives

Add new options.

add_configuration_options

HTMLWriterWithCustomDirectives

Add new options.

add_configuration_options

LatexWriterWithCustomDirectives

Add new options.

add_configuration_options

MDWriterWithCustomDirectives

Add new options.

add_configuration_options

RSTWriterWithCustomDirectives

Add new options.

add_configuration_options

_WriterWithCustomDirectives

Add new options.

add_context

MagicClassWithHelpers

add context to the class, mostly for debug purpose

add_css_file

_CustomSphinx

add_css_file

MockSphinxApp

See class Sphinx.

add_directive

_CustomSphinx

add_directive

MockSphinxApp

See class Sphinx.

add_directive_to_domain

_CustomSphinx

add_domain

_CustomSphinx

add_domain

MockSphinxApp

See class Sphinx.

add_env_collector

_CustomSphinx

See class Sphinx.

add_env_collector

MockSphinxApp

See class Sphinx.

add_event

_CustomSphinx

add_event

MockSphinxApp

See class Sphinx.

add_generic_role

_CustomSphinx

add_if_modified

FilesStatus

Adds a file to self.modifiedList if it was modified.

add_js_file

_CustomSphinx

add_js_file

MockSphinxApp

See class Sphinx.

add_label_if_not_present

IndexInformation

The function checks the label is present in the original file.

add_latex_package

_CustomSphinx

add_mapping

MockSphinxApp

See class Sphinx.

add_modified_file

FilesStatus

Adds a file the modified list of files.

add_node

_CustomSphinx

add_node

MockSphinxApp

See class Sphinx.

add_object_type

_CustomSphinx

add_piece

TransferAPI_FileInfo

add a piece

add_post_transform

_CustomSphinx

add_prefix

ModuleMemberDoc

Adds a prefix (for the documentation).

add_role

_CustomSphinx

add_role

MockSphinxApp

See class Sphinx.

add_role_to_domain

_CustomSphinx

add_secnumber

HTMLTranslatorWithCustomDirectives

Overwrites this method to catch errors due when it is a single document being processed.

add_secnumber

LatexTranslatorWithCustomDirectives

Overwrites this method to catch errors due when it is a single document being processed.

add_secnumber

MDTranslatorWithCustomDirectives

Overwrites this method to catch errors due when it is a single document being processed.

add_secnumber

RSTTranslatorWithCustomDirectives

Overwrites this method to catch errors due when it is a single document being processed.

add_secnumber

_AdditionalVisitDepart

Overwrites this method to catch errors due when it is a single document being processed.

add_source_parser

MockSphinxApp

Registers a parser for a specific file extension.

add_tag_slide

NotebookRunner

Tries to add tags for a slide show when they are too few.

add_text

DocTreeTranslator

add_text

EnhancedLaTeXTranslator

add_text

MdTranslator

add_text

RstTranslator

add_transform

_CustomSphinx

adjust_scheduler

JenkinsExt

Adjusts the scheduler to avoid having two jobs starting at the same time, jobs are delayed by an hour, two hours, …

align

ImageDirective

appendCommentLine

Doxypy

Appends a comment line. The comment delimiter is removed from multiline start and ends as well as singleline …

appendDefclassLine

Doxypy

Appends a line to the triggering block.

appendFileheadLine

Doxypy

Appends a line in the FILEHEAD state. Closes the open comment block, resets it and appends the current line.

appendNormalLine

Doxypy

Appends a line to the output.

apply_post_transforms

_CustomBuildEnvironment

Apply all post-transforms.

assemble_doctree

MemoryDocTreeBuilder

Overwrites assemble_doctree to control the doctree.

assemble_doctree

MemoryHTMLBuilder

Overwrites assemble_doctree to control the doctree.

assemble_doctree

MemoryLatexBuilder

Overwrites assemble_doctree to control the doctree.

assemble_doctree

MemoryMDBuilder

Overwrites assemble_doctree to control the doctree.

assemble_doctree

MemoryRSTBuilder

Overwrites assemble_doctree to control the doctree.

assemble_doctree

_MemoryBuilder

Overwrites assemble_doctree to control the doctree.

assertCallable

ExtTestCase

Checks that fct is callable.

assertEmpty

ExtTestCase

Checks that x is empty.

assertEndsWith

ExtTestCase

Checks that string sub ends with whole.

assertEqual

ExtTestCase

Checks that a == b.

assertEqualArray

ExtTestCase

Checks that two arrays are equal. Relies on numpy.testing.assert_almost_equal.html.

assertEqualDataFrame

ExtTestCase

Checks that two dataframes are equal. Calls pandas.testing.assert_frame_equal.

assertEqualDict

ExtTestCase

Checks that a == b.

assertEqualFloat

ExtTestCase

Checks that abs(a-b) < precision.

assertEqualNumber

ExtTestCase

Checks that two numbers are equal.

assertExists

ExtTestCase

Checks that name exists.

assertGreater

ExtTestCase

Checks that x >= y.

assertLesser

ExtTestCase

Checks that x <= y.

assertNotEmpty

ExtTestCase

Checks that x is not empty.

assertNotEndsWith

ExtTestCase

Checks that string sub does not end with whole.

assertNotEqual

ExtTestCase

Checks that a != b.

assertNotEqualArray

ExtTestCase

Checks that two arrays are equal. Relies on numpy.testing.assert_almost_equal.html.

assertNotEqualDataFrame

ExtTestCase

Checks that two dataframes are different. Calls pandas.testing.assert_frame_equal.

assertNotExists

ExtTestCase

Checks that name does not exist.

assertNotStartsWith

ExtTestCase

Checks that string sub does not start with whole.

assertRaise

ExtTestCase

Checks that function fct with no parameter raises an exception of a given type.

assertStartsWith

ExtTestCase

Checks that string sub starts with whole.

base_visit_image

CommonSphinxWriterHelpers

Processes an image. By default, it writes the image on disk. Inspired from visit_image

begin_test

StringIOAndFile

Redirects output to a io.StringIO.

bench

BenchMark

Runs the benchmark. Overwrite this method.

bench

GridBenchMark

run an experiment multiple times, parameter di is the dataset to use

bench_experiment

GridBenchMark

function to overload

build_members

AutoSignatureDirective

Extracts methods of a class and document them.

build_parameters_list

AutoSignatureDirective

Builds the list of parameters.

build_summary

AutoSignatureDirective

Extracts the part of the docstring before the parameters.

catchall

Doxypy

The catchall-condition, always returns true.

cell_height

NotebookRunner

Approximates the height of a cell by its number of lines it contains.

cell_image

NotebookRunner

Returns the cell image or None if not found.

cell_metadata

NotebookRunner

Returns the cell metadata.

cell_type

NotebookRunner

Returns the cell type.

check_attr

DownloadLinkFileCollector

clean_code

NotebookRunner

Cleans the code before running it, the function comment out instruction such as show().

cleanup

CustomSphinxApp

do some cleanup

clear_doc

DownloadLinkFileCollector

close

TransferFTP

close the connection

close

MockTransferFTP

does noting

close

TransferAPIFtp

close the connection

close

LogFakeFileStream

does nothing

close

LogFileStream

does nothing

close

StringIOAndFile

Calls two close.

close_stream

FolderTransferFTP

Closes a stream opened by preprocess_before_transfering().

compress

EncryptedBackup

compress data

compress

MagicCompress

connect

TransferAPIFtp

connect

connect

MockSphinxApp

See class Sphinx.

connect_directive_node

DocTreeWriterWithCustomDirectives

Adds custom node to the translator.

connect_directive_node

HTMLWriterWithCustomDirectives

Adds custom node to the translator.

connect_directive_node

LatexWriterWithCustomDirectives

Adds custom node to the translator.

connect_directive_node

MDWriterWithCustomDirectives

Adds custom node to the translator.

connect_directive_node

RSTWriterWithCustomDirectives

Adds custom node to the translator.

connect_directive_node

_WriterWithCustomDirectives

Adds custom node to the translator.

copy

NotebookRunner

Copies the notebook (just the content).

copy

DropDownWidget

calls deepcopy

copy

RadioWidget

calls deepcopy

copy

RangeWidget

calls deepcopy

copy

StaticWidget

calls deepcopy

copy_to

FileTreeNode

Copies the file to path.

count_code_cells

NotebookRunner

Returns the number of code cells in the notebook.

create_builder

_CustomSphinx

Creates a builder, raises an exception if name is None.

create_job_template

JenkinsExt

Adds a job to the Jenkins server.

create_picture_from

NotebookRunner

Creates a picture from text.

create_translator

MemoryDocTreeBuilder

Returns an instance of translator. This method returns an instance of default_translator_class by default. …

create_translator

MemoryHTMLBuilder

Returns an instance of translator. This method returns an instance of default_translator_class by default. …

create_translator

MemoryLatexBuilder

Returns an instance of translator. This method returns an instance of default_translator_class by default. …

create_translator

MemoryMDBuilder

Returns an instance of translator. This method returns an instance of default_translator_class by default. …

create_translator

MemoryRSTBuilder

Returns an instance of translator. This method returns an instance of default_translator_class by default. …

create_translator

_MemoryBuilder

Returns an instance of translator. This method returns an instance of default_translator_class by default. …

cwd

TransferFTP

go to a directory, if it does not exist, create it (if create is True)

debug

_CustomSphinx

decompress

EncryptedBackup

decompress data

decrypt_file

MagicCrypt

default_filters

UpgradedRSTExporter

Overrides in subclasses to provide extra filters. This should return an iterable of 2-tuples: (name, class-or-function). …

delete_all_jobs

JenkinsExt

Deletes all jobs permanently.

delete_job

JenkinsExt

Deletes Jenkins job permanently.

depart_CodeNode

MdTranslator

depart_CodeNode

RstTranslator

depart_Text

DocTreeTranslator

depart_Text

MdTranslator

depart_Text

RstTranslator

depart_abbreviation

MdTranslator

depart_abbreviation

RstTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

MdTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_admonition

RstTranslator

depart_attribution

MdTranslator

depart_attribution

RstTranslator

depart_bigger_node

RstTranslator

depart_block_quote

RstTranslator

depart_bullet_list

MdTranslator

depart_bullet_list

RstTranslator

depart_caption

MdTranslator

depart_caption

RstTranslator

depart_centered

MdTranslator

depart_centered

RstTranslator

depart_citation

MdTranslator

depart_citation

RstTranslator

depart_classifier

MdTranslator

depart_classifier

RstTranslator

depart_collapse_node

RstTranslator

depart_compact_paragraph

MdTranslator

depart_compact_paragraph

RstTranslator

depart_compound

MdTranslator

depart_compound

RstTranslator

depart_definition

MdTranslator

depart_definition

RstTranslator

depart_definition_list

MdTranslator

depart_definition_list

RstTranslator

depart_definition_list_item

MdTranslator

depart_definition_list_item

RstTranslator

depart_desc

MdTranslator

depart_desc

RstTranslator

depart_desc_addname

MdTranslator

depart_desc_addname

RstTranslator

depart_desc_annotation

MdTranslator

depart_desc_annotation

RstTranslator

depart_desc_content

MdTranslator

depart_desc_content

RstTranslator

depart_desc_name

MdTranslator

depart_desc_name

RstTranslator

depart_desc_optional

MdTranslator

depart_desc_optional

RstTranslator

depart_desc_parameterlist

MdTranslator

depart_desc_parameterlist

RstTranslator

depart_desc_returns

MdTranslator

depart_desc_returns

RstTranslator

depart_desc_signature

MdTranslator

depart_desc_signature

RstTranslator

depart_desc_type

MdTranslator

depart_desc_type

RstTranslator

depart_description

MdTranslator

depart_description

RstTranslator

depart_doctest_block

MdTranslator

depart_doctest_block

RstTranslator

depart_document

DocTreeTranslator

depart_document

MdTranslator

depart_document

RstTranslator

depart_download_reference

MdTranslator

depart_download_reference

RstTranslator

depart_downloadlink_node

MdTranslator

depart_downloadlink_node

RstTranslator

depart_emphasis

MdTranslator

depart_emphasis

RstTranslator

depart_entry

MdTranslator

depart_entry

RstTranslator

depart_enumerated_list

MdTranslator

depart_enumerated_list

RstTranslator

depart_field

MdTranslator

depart_field

RstTranslator

depart_field_body

MdTranslator

depart_field_body

RstTranslator

depart_field_list

MdTranslator

depart_field_list

RstTranslator

depart_field_name

MdTranslator

depart_field_name

RstTranslator

depart_figure

MdTranslator

depart_figure

RstTranslator

depart_footnote

MdTranslator

depart_footnote

RstTranslator

depart_generated

MdTranslator

depart_generated

RstTranslator

depart_gitlog_node

RstTranslator

depart_glossary

MdTranslator

depart_glossary

RstTranslator

depart_hlist

MdTranslator

depart_hlist

RstTranslator

depart_hlistcol

MdTranslator

depart_hlistcol

RstTranslator

depart_image

MdTranslator

depart_image

RstTranslator

depart_image_node_fallback

Backend

translator method

depart_image_node_html

LightBox2

translator method

depart_inheritance_diagram

EnhancedLaTeXTranslator

depart_inheritance_diagram

MdTranslator

depart_inheritance_diagram

RstTranslator

depart_inline

MdTranslator

depart_inline

RstTranslator

depart_issue

MdTranslator

depart_issue

RstTranslator

depart_line

MdTranslator

depart_line

RstTranslator

depart_line_block

MdTranslator

depart_line_block

RstTranslator

depart_list_item

MdTranslator

depart_list_item

RstTranslator

depart_literal

MdTranslator

depart_literal

RstTranslator

depart_literal_block

MdTranslator

depart_literal_block

RstTranslator

depart_literal_emphasis

MdTranslator

depart_literal_emphasis

RstTranslator

depart_only

HTMLTranslatorWithCustomDirectives

depart_only

LatexTranslatorWithCustomDirectives

depart_only

MDTranslatorWithCustomDirectives

depart_only

RSTTranslatorWithCustomDirectives

depart_only

_AdditionalVisitDepart

depart_only

EnhancedLaTeXTranslator

depart_only

MdTranslator

depart_only

RstTranslator

depart_option

MdTranslator

depart_option

RstTranslator

depart_option_argument

MdTranslator

depart_option_argument

RstTranslator

depart_option_group

MdTranslator

depart_option_group

RstTranslator

depart_option_list

MdTranslator

depart_option_list

RstTranslator

depart_option_list_item

MdTranslator

depart_option_list_item

RstTranslator

depart_option_string

MdTranslator

depart_option_string

RstTranslator

depart_paragraph

MdTranslator

depart_paragraph

RstTranslator

depart_pending_xref

MdTranslator

depart_pending_xref

RstTranslator

depart_problematic

MdTranslator

depart_problematic

RstTranslator

depart_quote_node

RstTranslator

depart_refcount

MdTranslator

depart_refcount

RstTranslator

depart_reference

MdTranslator

depart_reference

RstTranslator

depart_row

MdTranslator

depart_row

RstTranslator

depart_rubric

MdTranslator

depart_rubric

RstTranslator

depart_runpythonthis_node

MdTranslator

depart_runpythonthis_node

RstTranslator

depart_section

MdTranslator

depart_section

RstTranslator

depart_seealso

MdTranslator

depart_seealso

RstTranslator

depart_sharenet_node

RstTranslator

depart_simpleimage

MdTranslator

depart_simpleimage

RstTranslator

depart_strong

MdTranslator

depart_strong

RstTranslator

depart_subscript

MdTranslator

depart_subscript

RstTranslator

depart_subtitle

MdTranslator

depart_subtitle

RstTranslator

depart_superscript

MdTranslator

depart_superscript

RstTranslator

depart_table

MdTranslator

depart_table

RstTranslator

depart_target

RstTranslator

depart_tbody

MdTranslator

depart_tbody

RstTranslator

depart_term

MdTranslator

depart_term

RstTranslator

depart_tgroup

MdTranslator

depart_tgroup

RstTranslator

depart_thead

MdTranslator

depart_thead

RstTranslator

depart_title

MdTranslator

depart_title

RstTranslator

depart_title_reference

MdTranslator

depart_title_reference

RstTranslator

depart_topic

MdTranslator

depart_topic

MdTranslator

depart_topic

RstTranslator

depart_topic

RstTranslator

depart_versionmodified

RstTranslator

difference

FileTreeNode

Returns the differences with another folder.

difference

FilesStatus

Goes through the list of files and tells which one has changed.

difftext

MagicDiff

defines %difftext which calls textdiff() but should be easier to remember

dir

TransferFTP

Lists the content of a path.

disconnect_env_collector

_CustomSphinx

Disables a collector given its class name.

disconnect_env_collector

MockSphinxApp

Disconnects a collector given its class name.

do_GET

DocumentationHandler

What to do is case of GET request.

do_POST

DocumentationHandler

What to do is case of POST request.

do_redirect

DocumentationHandler

Redirection when url is just the website.

emit

MockSphinxApp

See class Sphinx.

emit_firstresult

MockSphinxApp

See class Sphinx.

enable

CustomTocTreeCollector

encrypt_file

MagicCrypt

end

BenchMark

Cleans. Overwrites this method.

end_state

DocTreeTranslator

end_state

MdTranslator

end_state

RstTranslator

end_test

StringIOAndFile

Ends the redirection.

enumerate_ls

TransferFTP

enumerate the content of a path

enumerate_read_encrypt

EncryptedBackup

enumerate pieces of files as bytes

eof

_AsyncLineReader

eval

MagicCommandParser

Evaluate a string knowing the context, it returns value if it does not belong to the context or if it …

eval_expr

HTMLTranslatorWithCustomDirectives

eval_expr

LatexTranslatorWithCustomDirectives

eval_expr

MDTranslatorWithCustomDirectives

eval_expr

RSTTranslatorWithCustomDirectives

eval_expr

_AdditionalVisitDepart

eval_expr

EnhancedLaTeXTranslator

eval_expr

MdTranslator

eval_expr

RstTranslator

exists

FileTreeNode

say if it does exist or not

expected_eval_type

MagicCommandParser

return the expected evaluation type for the parameter (if the value is interpreter as a python expression)

expected_type

MagicCommandParser

Returns the expected type for the parameter.

extract_requirements

JenkinsExt

Extracts the requirements for a job.

fLOG

BenchMark

Logs something.

fLOG

CustomLog

Builds a message on a single line with the date, it deals with encoding issues.

fLOG

ExtTestCase

Prints out some information. fLOG().

feed

DocumentationHandler

Displays something.

fill_node

BlogPostDirective

Fills the content of the node.

fill_node

BlogPostDirectiveAgg

Fill the node of an aggregated page.

finalize

_CustomSphinx

Finalizes the documentation after it was parsed.

finalize

MockSphinxApp

Finalizes the documentation after it was parsed.

finish

DocTreeBuilder

finish

EnhancedLaTeXBuilder

finish

MdBuilder

finish

RstBuilder

first_cell

NotebookRunner

Returns the first cell.

fix_refuris

MemoryDocTreeBuilder

Overwrites fix_refuris to control the reference names.

fix_refuris

MemoryHTMLBuilder

Overwrites fix_refuris to control the reference names.

fix_refuris

MemoryLatexBuilder

Overwrites fix_refuris to control the reference names.

fix_refuris

MemoryMDBuilder

Overwrites fix_refuris to control the reference names.

fix_refuris

MemoryRSTBuilder

Overwrites fix_refuris to control the reference names.

fix_refuris

_MemoryBuilder

Overwrites fix_refuris to control the reference names.

flush

LogFakeFileStream

does nothing

flush

LogFileStream

does nothing

flush

StringIOAndFile

Calls two flush.

fprint

BufferedPrint

print function

get

FileTreeNode

return a dictionary with some values which describe the file

get_args

MagicClassWithHelpers

parser a command line with a given parser

get_categories

BlogPostList

Extracts the categories.

get_categories_group

BlogPostList

Extracts the categories with the posts associated to it.

get_cmd_standalone

JenkinsExt

Custom command for Jenkins (such as updating conda)

get_content

FileTreeNode

Returns the content of a text file.

get_default_values

MockSphinxApp

See class Sphinx.

get_description

NotebookRunner

Gets summary and description of this notebook. We expect the first cell to contain a title and a description …

get_dict

FileTreeNode

Returns a dictionary { self._file : node }.

get_doctree

_CustomBuildEnvironment

Read the doctree for a file from the pickle and return it.

get_engine_from_job

JenkinsExt

Extracts the engine from the job definition, it should be like [engine].

get_file_content

DocumentationHandler

Returns the content of a local file.

get_files

BlogPostList

Extracts the files.

get_fullname

FileTreeNode

get_image

BlogPostList

Returns the local path to an image in this folder.

get_jenkins_job_name

JenkinsExt

Infers a name for the jenkins job.

get_jenkins_script

JenkinsExt

Builds the Jenkins script for a module and its options.

get_jobs

JenkinsExt

Gets the list of all jobs recursively to the given folder depth, see get_all_jobs. …

get_keywords

BlogPostList

Extracts the categories.

get_last_commit_hash

SourceRepository

Returns the last commit.

get_months

BlogPostList

Extracts the months.

get_months_group

BlogPostList

Extracts the months with the posts associated to it.

get_outdated_docs

DocTreeBuilder

Return an iterable of input files that are outdated. This method is taken from TextBuilder.get_outdated_docs()

get_outdated_docs

MdBuilder

Return an iterable of input files that are outdated. This method is taken from TextBuilder.get_outdated_docs()

get_outdated_docs

RstBuilder

Return an iterable of input files that are outdated. This method is taken from TextBuilder.get_outdated_docs()

get_outfilename

MemoryDocTreeBuilder

Overwrites get_target_uri to control file names.

get_outfilename

MemoryHTMLBuilder

Overwrites get_target_uri to control file names.

get_outfilename

MemoryLatexBuilder

Overwrites get_target_uri to control file names.

get_outfilename

MemoryMDBuilder

Overwrites get_target_uri to control file names.

get_outfilename

MemoryRSTBuilder

Overwrites get_target_uri to control file names.

get_outfilename

_MemoryBuilder

Overwrites get_target_uri to control file names.

get_outfilename

DocTreeBuilder

Overwrites get_target_uri to control file names.

get_outfilename

EnhancedLaTeXBuilder

Overwrites get_target_uri to control file names.

get_outfilename

MdBuilder

Overwrite get_target_uri to control file names.

get_outfilename

RstBuilder

Overwrites get_target_uri to control file names.

get_parser

MagicClassWithHelpers

returns a parser for a magic command, initialize it if it does not exists, it creates. The parsers are stored …

get_projects

GitLabAPI

returns a list of dictionaries

get_remote_path

MockTransferAPI

produces a remote path

get_remote_path

TransferAPI

produces a remote path

get_rst_links_down

BlogPostList

Builds the rst links to months or categories to displays the bottom of the aggregated pages.

get_rst_links_up

BlogPostList

Builds the rst links to months or categories to displays at the beginning of the aggregated pages.

get_target_uri

MemoryDocTreeBuilder

Overwrites get_target_uri to control the page name.

get_target_uri

MemoryHTMLBuilder

Overwrites get_target_uri to control the page name.

get_target_uri

MemoryLatexBuilder

Overwrites get_target_uri to control the page name.

get_target_uri

MemoryMDBuilder

Overwrites get_target_uri to control the page name.

get_target_uri

MemoryRSTBuilder

Overwrites get_target_uri to control the page name.

get_target_uri

_MemoryBuilder

Overwrites get_target_uri to control the page name.

get_target_uri

DocTreeBuilder

get_target_uri

MdBuilder

get_target_uri

RstBuilder

get_thumbnail

NotebookRunner

Processes the notebook and creates one picture based on the outputs to illustrate a notebook.

getvalue

StringIOAndFile

Returns the content of the buffer.

graphs

BenchMark

Builds graphs after the benchmark was run.

handle_page

MemoryDocTreeBuilder

Override handle_page to write into stream instead of files.

handle_page

MemoryHTMLBuilder

Overrides handle_page to write into stream instead of files.

handle_page

MemoryLatexBuilder

Overrides handle_page to write into stream instead of files.

handle_page

MemoryMDBuilder

Override handle_page to write into stream instead of files.

handle_page

MemoryRSTBuilder

Override handle_page to write into stream instead of files.

handle_page

_MemoryBuilder

Overrides handle_page to write into stream instead of files.

handle_page

DocTreeBuilder

handle_page

MdBuilder

handle_page

RstBuilder

has_been_modified_and_reason

FilesStatus

Returns (True, reason) if a file was modified or (False, None) if not.

has_choices

MagicCommandParser

tells if a parameter has choises

has_eval

MagicCommandParser

Tells if a parameter value should be consider as a variable or some python code to evaluate.

hash_md5_readfile

FileTreeNode

Computes a hash of a file.

hash_md5_readfile

CommonSphinxWriterHelpers

Computes a hash of a file.

html

StaticInteract

Produce the HTML output, insert results from _output_html() and _widget_html() and insert it into the …

html

DropDownWidget

return HTML string

html

RadioWidget

return HTML string

html

RangeWidget

HTML code

html

StaticWidget

abstract method

htmlhelp

MagicClassExample

Defines %htmlhelp, it displays the help for an object in HTML.

info

_CustomSphinx

init

BenchMark

Initialisation. Overwrite this method.

init

GridBenchMark

Skips it.

init

DocTreeBuilder

Load necessary templates and perform initialization.

init

MdBuilder

Load necessary templates and perform initialization.

init

RstBuilder

Load necessary templates and perform initialization.

init_main

GridBenchMark

initialisation

is_doctree

HTMLTranslatorWithCustomDirectives

Tells if the translator is doctree format.

is_doctree

LatexTranslatorWithCustomDirectives

Tells if the translator is doctree format.

is_doctree

MDTranslatorWithCustomDirectives

Tells if the translator is doctree format.

is_doctree

RSTTranslatorWithCustomDirectives

Tells if the translator is doctree format.

is_doctree

_AdditionalVisitDepart

Tells if the translator is doctree format.

is_html

HTMLTranslatorWithCustomDirectives

Tells if the translator is html format.

is_html

LatexTranslatorWithCustomDirectives

Tells if the translator is html format.

is_html

MDTranslatorWithCustomDirectives

Tells if the translator is html format.

is_html

RSTTranslatorWithCustomDirectives

Tells if the translator is html format.

is_html

_AdditionalVisitDepart

Tells if the translator is html format.

is_latex

HTMLTranslatorWithCustomDirectives

Tells if the translator is latex format.

is_latex

LatexTranslatorWithCustomDirectives

Tells if the translator is latex format.

is_latex

MDTranslatorWithCustomDirectives

Tells if the translator is latex format.

is_latex

RSTTranslatorWithCustomDirectives

Tells if the translator is latex format.

is_latex

_AdditionalVisitDepart

Tells if the translator is latex format.

is_md

HTMLTranslatorWithCustomDirectives

Tells if the translator is markdown format.

is_md

LatexTranslatorWithCustomDirectives

Tells if the translator is markdown format.

is_md

MDTranslatorWithCustomDirectives

Tells if the translator is markdown format.

is_md

RSTTranslatorWithCustomDirectives

Tells if the translator is markdown format.

is_md

_AdditionalVisitDepart

Tells if the translator is markdown format.

is_remote

ImageDirective

local function

is_rst

HTMLTranslatorWithCustomDirectives

Tells if the translator is rst format.

is_rst

LatexTranslatorWithCustomDirectives

Tells if the translator is rst format.

is_rst

MDTranslatorWithCustomDirectives

Tells if the translator is rst format.

is_rst

RSTTranslatorWithCustomDirectives

Tells if the translator is rst format.

is_rst

_AdditionalVisitDepart

Tells if the translator is rst format.

isdir

FileTreeNode

is it a folder?

isfile

FileTreeNode

is it a file?

iter_cells

NotebookRunner

Iterates over the notebook cells.

iter_code_cells

NotebookRunner

Iterates over the notebook cells containing code.

iter_eligible_files

EncryptedBackup

iterates on eligible file for transfering (if they have been modified)

iter_eligible_files

FolderTransferFTP

Iterates on eligible file for transfering (if they have been modified).

iter_modified

FilesStatus

Iterates on all modified files yield a couple (filename, reason).

iter_pages

MemoryDocTreeBuilder

Enumerate created pages.

iter_pages

MemoryHTMLBuilder

Enumerate created pages.

iter_pages

MemoryLatexBuilder

Enumerate created pages.

iter_pages

MemoryMDBuilder

Enumerate created pages.

iter_pages

MemoryRSTBuilder

Enumerate created pages.

iter_pages

_MemoryBuilder

Enumerate created pages.

jenkins_open

JenkinsExt

Overloads the same method from module python-jenkins to replace string by bytes.

latex_image_length

EnhancedLaTeXTranslator

load_mapping

EncryptedBackup

retrieves existing mapping

log

SourceRepository

Gets the latest changes operated on a file in a folder or a subfolder.

log_unknown

DocTreeTranslator

log_unknown

MdTranslator

log_unknown

RstTranslator

login

GitLabAPI

login

ls

TransferFTP

list the content of a path

ls

SourceRepository

Extracts the content of a location.

makeCommentBlock

Doxypy

Indents the current comment block with respect to the current indentation level.

makeTransition

FSM

Makes a transition based on the given input.

max_date

FileTreeNode

return the more recent date

merge_notebook

NotebookRunner

Appends notebook nb to this one.

merge_other

DownloadLinkFileCollector

meta_to_df

BenchMark

Converts meta data into a dataframe

mkd

TransferFTP

creates a directory

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

nb_children

FileTreeNode

return the number of children

nb_commits

SourceRepository

Returns the number of commits.

new_state

DocTreeTranslator

new_state

MdTranslator

new_state

RstTranslator

open

WinZipFile

Returns file-like object for ‘name’.

open

LogFakeFileStream

does nothing

open

LogFileStream

does nothing

override_domain

_CustomSphinx

override_transform

OverrideDocFieldTransformer

Transform a single field list node. Overwrite function transform. …

parse

Doxypy

Parses a python file given as input string and returns the doxygen- compatible representation.

parse

PlotScriptParser

Parse source, write results to document.

parseFile

Doxypy

Parses a python file given as input string and returns` the doxygen compatible representation.

parseLine

Doxypy

Parses one line of python and flush the resulting output to the outstream.

parse_cmd

MagicCommandParser

split line using shlex and call parse_args

populate

ModuleMemberDoc

Extracts some information about an object.

post_as_rst

BlogPost

Reproduces the text of the blog post, updates the image links.

predict_score_experiment

GridBenchMark

function to overload

prepare_writing

DocTreeBuilder

prepare_writing

MdBuilder

prepare_writing

RstBuilder

preprocess_before_transfering

FolderTransferFTP

Applies some preprocessing to the file to transfer. It adds the footer for example. It returns a stream …

preprocess_cell

LatexRawOutputPreprocessor

Apply a transformation on each cell. See base.py for details, add \begin{verbatim} and \end{verbatim}.

preprocess_dataset

GridBenchMark

split the dataset into train and test

print_list

TransferFTP

return the list of files in the current directory the function sends eveything to the logging function

private_run

BlocRef

Builds a node blocref_node.

process_doc

DownloadLinkFileCollector

Process downloadable file paths.

process_doc

CustomTocTreeCollector

Build a TOC from the doctree and store it in the inventory.

process_options

JenkinsExt

Postprocesses a script inserted in a job definition.

profile

ExtTestCase

Profiles the execution of a function.

pwd

TransferFTP

Return the pathname of the current directory on the server.

read

open_stream_file

Reads some bytes.

read_file

ExtTestCase

Returns the content of a file.

readline

open_stream_file

Basic implementation.

readlines

open_stream_file

Basic implementation.

remove

FileTreeNode

Removes the file.

renamed

DropDownWidget

rename name if name is an attribute

renamed

RadioWidget

rename name if name is an attribute

renamed

RangeWidget

rename name if name is an attribute

renamed

StaticWidget

rename name if name is an attribute

repo_ls

FileTreeNode

call ls of an instance of SourceRepository

report

BenchMark

Produces a report.

require_sphinx

MockSphinxApp

resetCommentSearch

Doxypy

Restarts a new comment search for a different triggering line. Closes the current commentblock and starts a new …

retrieve

EncryptedBackup

retrieve a backuped file

retrieve

TransferFTP

downloads a file

retrieve

MockTransferAPI

retrieve data from path

retrieve

TransferAPI

retrieve data from path

retrieve

TransferAPIFile

retrieve data from path

retrieve

TransferAPIFtp

retrieve data from path

retrieve_all

EncryptedBackup

retrieve all backuped files

retrieve_mapping

MockTransferAPI

returns the mapping

retrieve_mapping

TransferAPI

returns the mapping

rst_link

IndexInformation

return a link rst

rst_link

ModuleMemberDoc

Returns a sphinx link on the object.

run

BenchMark

Runs the benchmark.

run

GridBenchMark

Runs the benchmark.

run

_AsyncLineReader

run

DocumentationThreadServer

Runs the server.

run

BokehPlotDirective

run

RevealjsDirective

build revealjs node

run

RvCodeDirective

build rv_code node

run

RvNoteDirective

build rv_note node

run

RvSmallDirective

build rv_small node

run

AutoSignatureDirective

run

BlocRef

Builds a node blocref_node.

run

BlocRefList

Simply insert an empty blocreflist node which will be replaced later when process_blocref_nodes is called

run

BlogPostDirective

extracts the information in a dictionary and displays it if the environment is not null

run

BlogPostDirectiveAgg

extracts the information in a dictionary and displays it if the environment is not null

run

BlogPostListDirective

run

CmdRef

calls run from BlocRef and add index entries by default

run

CmdRefList

calls run from BlocRefList and add default tag if not present

run

CollapseDirective

Builds the collapse text.

run

ExRef

calls run from BlocRef and add defaut tag

run

ExRefList

calls run from BlocRefList and add default tag if not present

run

FaqRef

calls run from BlocRef and add defaut tag

run

FaqRefList

calls run from BlocRefList and add default tag if not present

run

SimpleImageDirective

Runs the directive.

run

MathDef

Builds the mathdef text.

run

MathDefList

Simply insert an empty mathdeflist node which will be replaced later when process_mathdef_nodes is called

run

NbRef

calls run from BlocRef and add index entries by default

run

NbRefList

calls run from BlocRefList and add default tag if not present

run

PostContentsDirective

Just add a postcontents_node.

run

QuoteNode

Builds the mathdef text.

run

RunPythonDirective

Extracts the information in a dictionary, runs the script.

run

ShareNetDirective

Runs the directve.

run

TocDelayDirective

Just add a tocdelay_node and list the documents to add.

run

CustomTocTree

run

TodoExt

builds the todo text

run

TodoExtList

Simply insert an empty todoextlist node which will be replaced later when process_todoext_nodes is called

run

VideoDirective

Runs the directive.

run

YoutubeDirective

run

ImageDirective

run_cell

NotebookRunner

Runs a notebook cell and update the output of that cell in-place.

run_command

MockTransferFTP

Mock method run_command

run_command

TransferFTP

run a FTP command

run_notebook

NotebookRunner

Runs all the cells of a notebook in order and update the outputs in-place. If skip_exceptions is set, …

save_dates

FilesStatus

Saves the status of the copy.

send_headers

DocumentationHandler

defines the header to send (type of files) based on path

serve_content

DocumentationHandler

Tells what to do based on the path. The function intercepts the path /localfile/, otherwise it calls serve_content_web. …

serve_content_web

DocumentationHandler

Functions to overload (executed after serve_content).

serve_main_page

DocumentationHandler

Displays all the mapping for the default path.

setStartState

FSM

setUp

ExtTestCase

Filters out FutureWarning, PendingDeprecationWarning.

set_date

FileInfo

set date

set_md5

FileInfo

set md5

set_mdate

FileInfo

set mdate

set_rst_file

IndexInformation

Sets the rst file and checks the label is present in it.

setup_extension

_CustomSphinx

setup_extension

MockSphinxApp

See class Sphinx.

setup_jenkins_server

JenkinsExt

Sets up many jobs in Jenkins.

shutdown

DocumentationHandler

Shuts down the service.

shutdown

DocumentationThreadServer

Shuts down the server, if it does not work, you can still kill the thread:

shutdown_kernel

NotebookRunner

Shuts down kernel.

sign

FileTreeNode

Returns ==, < or > according the dates if the size is not too big, if the sign is < or >, …

startCommentSearch

Doxypy

Starts a new comment search. Saves the triggering line, resets the current comment and saves the current …

start_transfering

EncryptedBackup

starts transfering files to the remote website

start_transfering

FolderTransferFTP

Starts transfering files to a remote FTP website.

stopCommentSearch

Doxypy

Stops a comment search. Closes the current commentblock, resets the triggering line and appends the current …

suffix_label

BlogPostDirective

returns a suffix to add to a label, it should not be empty for aggregated pages

suffix_label

BlogPostDirectiveAgg

returns a suffix to add to a label, it should not be empty for aggregated pages

tearDown

ExtTestCase

Stops filtering out FutureWarning, PendingDeprecationWarning.

textdiff

MagicDiff

to_df

BenchMark

Converts the metrics into a dataframe.

to_json

TransferAPI_FileInfo

serializes this class info JSON

to_json

NotebookRunner

Converts the notebook into JSON.

to_python

NotebookRunner

Converts the notebook into python.

transfer

EncryptedBackup

transfer data

transfer

TransferFTP

transfers a file

transfer

MockTransferFTP

does nothing, returns True

transfer

MockTransferAPI

we assume a data holds in memory, tansfer data to path

transfer

TransferAPI

we assume a data holds in memory, tansfer data to path

transfer

TransferAPIFile

It assumes a data holds in memory, tansfer data to path.

transfer

TransferAPIFtp

It assumes a data holds in memory, tansfer data to path.

transfer_mapping

EncryptedBackup

transfer the mapping

transfer_mapping

MockTransferAPI

transfer the mapping

transfer_mapping

TransferAPI

transfer the mapping

translate

DocTreeWriterWithCustomDirectives

translate

HTMLWriterWithCustomDirectives

translate

LatexWriterWithCustomDirectives

translate

MDWriterWithCustomDirectives

translate

RSTWriterWithCustomDirectives

translate

DocTreeWriter

translate

EnhancedLaTeXWriter

translate

MdWriter

translate

RstWriter

uncache

BenchMark

overwrite this method to uncache some previous run

unknown_departure

DocTreeTranslator

unknown_visit

HTMLTranslatorWithCustomDirectives

unknown_visit

LatexTranslatorWithCustomDirectives

unknown_visit

MDTranslatorWithCustomDirectives

unknown_visit

RSTTranslatorWithCustomDirectives

unknown_visit

_AdditionalVisitDepart

unknown_visit

DocTreeTranslator

unknown_visit

EnhancedLaTeXTranslator

unknown_visit

MdTranslator

unknown_visit

RstTranslator

update_copied_file

FilesStatus

Updates the file in copyFiles (before saving), update all fields.

update_mapping

EncryptedBackup

update the status of a file

update_status

EncryptedBackup

update the status of a file

update_status

FolderTransferFTP

Updates the status of a file.

values

DropDownWidget

return all possible values

values

RadioWidget

return all the possible values

values

RangeWidget

version

SourceRepository

Gets the latest check in number for a specific path.

visit_CodeNode

MdTranslator

visit_CodeNode

RstTranslator

visit_Text

DocTreeTranslator

visit_Text

MdTranslator

visit_Text

RstTranslator

visit_abbreviation

MdTranslator

visit_abbreviation

RstTranslator

visit_acks

MdTranslator

visit_acks

RstTranslator

visit_admonition

MdTranslator

visit_admonition

RstTranslator

visit_attribution

MdTranslator

visit_attribution

RstTranslator

visit_bigger_node

RstTranslator

visit_block_quote

RstTranslator

visit_bullet_list

MdTranslator

visit_bullet_list

RstTranslator

visit_caption

MdTranslator

visit_caption

RstTranslator

visit_centered

MdTranslator

visit_centered

RstTranslator

visit_citation

MdTranslator

visit_citation

RstTranslator

visit_citation_reference

MdTranslator

visit_citation_reference

RstTranslator

visit_classifier

MdTranslator

visit_classifier

RstTranslator

visit_collapse_node

RstTranslator

visit_colspec

MdTranslator

visit_colspec

RstTranslator

visit_comment

MdTranslator

visit_comment

RstTranslator

visit_compact_paragraph

MdTranslator

visit_compact_paragraph

RstTranslator

visit_compound

MdTranslator

visit_compound

RstTranslator

visit_definition

MdTranslator

visit_definition

RstTranslator

visit_definition_list

MdTranslator

visit_definition_list

RstTranslator

visit_definition_list_item

MdTranslator

visit_definition_list_item

RstTranslator

visit_desc

MdTranslator

visit_desc

RstTranslator

visit_desc_addname

MdTranslator

visit_desc_addname

RstTranslator

visit_desc_annotation

MdTranslator

visit_desc_annotation

RstTranslator

visit_desc_content

MdTranslator

visit_desc_content

RstTranslator

visit_desc_name

MdTranslator

visit_desc_name

RstTranslator

visit_desc_optional

MdTranslator

visit_desc_optional

RstTranslator

visit_desc_parameter

MdTranslator

visit_desc_parameter

RstTranslator

visit_desc_parameterlist

MdTranslator

visit_desc_parameterlist

RstTranslator

visit_desc_returns

MdTranslator

visit_desc_returns

RstTranslator

visit_desc_signature

MdTranslator

visit_desc_signature

RstTranslator

visit_desc_type

MdTranslator

visit_desc_type

RstTranslator

visit_description

MdTranslator

visit_description

RstTranslator

visit_doctest_block

MdTranslator

visit_doctest_block

RstTranslator

visit_document

DocTreeTranslator

visit_document

EnhancedLaTeXTranslator

visit_document

MdTranslator

visit_document

RstTranslator

visit_download_reference

MdTranslator

visit_download_reference

RstTranslator

visit_downloadlink_node

MdTranslator

visit_downloadlink_node

RstTranslator

visit_emphasis

MdTranslator

visit_emphasis

RstTranslator

visit_entry

MdTranslator

visit_entry

RstTranslator

visit_enumerated_list

EnhancedLaTeXTranslator

visit_enumerated_list

MdTranslator

visit_enumerated_list

RstTranslator

visit_field

HTMLTranslatorWithCustomDirectives

visit_field

MdTranslator

visit_field

RstTranslator

visit_field_body

MdTranslator

visit_field_body

RstTranslator

visit_field_list

MdTranslator

visit_field_list

RstTranslator

visit_field_name

MdTranslator

visit_field_name

RstTranslator

visit_figure

MdTranslator

visit_figure

RstTranslator

visit_footnote

MdTranslator

visit_footnote

RstTranslator

visit_footnote_reference

MdTranslator

visit_footnote_reference

RstTranslator

visit_generated

MdTranslator

visit_generated

RstTranslator

visit_gitlog_node

RstTranslator

visit_glossary

MdTranslator

visit_glossary

RstTranslator

visit_highlightlang

MdTranslator

visit_highlightlang

RstTranslator

visit_hlist

MdTranslator

visit_hlist

RstTranslator

visit_hlistcol

MdTranslator

visit_hlistcol

RstTranslator

visit_image

MdTranslator

visit_image

RstTranslator

visit_image_node_fallback

Backend

translator method

visit_image_node_html

LightBox2

translator method

visit_index

MdTranslator

visit_index

RstTranslator

visit_inheritance_diagram

EnhancedLaTeXTranslator

visit_inheritance_diagram

MdTranslator

visit_inheritance_diagram

RstTranslator

visit_inline

MdTranslator

visit_inline

RstTranslator

visit_issue

MdTranslator

visit_issue

RstTranslator

visit_label

MdTranslator

visit_label

RstTranslator

visit_line

MdTranslator

visit_line

RstTranslator

visit_line_block

MdTranslator

visit_line_block

RstTranslator

visit_list_item

MdTranslator

visit_list_item

RstTranslator

visit_literal

MdTranslator

visit_literal

RstTranslator

visit_literal_block

MdTranslator

visit_literal_block

RstTranslator

visit_literal_emphasis

MdTranslator

visit_literal_emphasis

RstTranslator

visit_meta

MdTranslator

visit_meta

RstTranslator

visit_only

HTMLTranslatorWithCustomDirectives

visit_only

LatexTranslatorWithCustomDirectives

visit_only

MDTranslatorWithCustomDirectives

visit_only

RSTTranslatorWithCustomDirectives

visit_only

_AdditionalVisitDepart

visit_only

EnhancedLaTeXTranslator

visit_only

MdTranslator

visit_only

RstTranslator

visit_option

MdTranslator

visit_option

RstTranslator

visit_option_argument

MdTranslator

visit_option_argument

RstTranslator

visit_option_group

MdTranslator

visit_option_group

RstTranslator

visit_option_list

MdTranslator

visit_option_list

RstTranslator

visit_option_list_item

MdTranslator

visit_option_list_item

RstTranslator

visit_option_string

MdTranslator

visit_option_string

RstTranslator

visit_paragraph

MdTranslator

visit_paragraph

RstTranslator

visit_pending_xref

HTMLTranslatorWithCustomDirectives

visit_pending_xref

MdTranslator

visit_pending_xref

RstTranslator

visit_problematic

MdTranslator

visit_problematic

RstTranslator

visit_productionlist

MdTranslator

visit_productionlist

RstTranslator

visit_quote_node

RstTranslator

visit_raw

MdTranslator

visit_raw

RstTranslator

visit_refcount

MdTranslator

visit_refcount

RstTranslator

visit_reference

MdTranslator

visit_reference

RstTranslator

Runs upon entering a reference. Because this class inherits from the TextTranslator class, regularly defined …

visit_row

MdTranslator

visit_row

RstTranslator

visit_rubric

MdTranslator

visit_rubric

RstTranslator

visit_runpythonthis_node

MdTranslator

visit_runpythonthis_node

RstTranslator

visit_section

MdTranslator

visit_section

RstTranslator

visit_seealso

MdTranslator

visit_seealso

RstTranslator

visit_sharenet_node

RstTranslator

visit_simpleimage

MdTranslator

visit_simpleimage

RstTranslator

visit_strong

MdTranslator

visit_strong

RstTranslator

visit_subscript

MdTranslator

visit_subscript

RstTranslator

visit_substitution_definition

MdTranslator

visit_substitution_definition

RstTranslator

visit_subtitle

MdTranslator

visit_subtitle

RstTranslator

visit_superscript

MdTranslator

visit_superscript

RstTranslator

visit_system_message

MdTranslator

visit_system_message

RstTranslator

visit_table

MdTranslator

visit_table

RstTranslator

visit_tabular_col_spec

MdTranslator

visit_tabular_col_spec

RstTranslator

visit_target

MdTranslator

visit_target

RstTranslator

visit_tbody

MdTranslator

visit_tbody

RstTranslator

visit_term

MdTranslator

visit_term

RstTranslator

visit_termsep

MdTranslator

visit_termsep

RstTranslator

visit_tgroup

MdTranslator

visit_tgroup

RstTranslator

visit_thead

MdTranslator

visit_thead

RstTranslator

visit_title

MdTranslator

visit_title

RstTranslator

visit_title_reference

MdTranslator

visit_title_reference

RstTranslator

visit_topic

MdTranslator

visit_topic

MdTranslator

visit_topic

RstTranslator

visit_topic

RstTranslator

visit_transition

MdTranslator

visit_transition

RstTranslator

visit_versionmodified

RstTranslator

warning

_CustomSphinx

wrap

DocTreeTranslator

wrap

MdTranslator

wrap

RstTranslator

write

DocTreeWriterWithCustomDirectives

Processes a document into its final form. Translates document (a Docutils document tree) into the Writer’s …

write

HTMLWriterWithCustomDirectives

Processes a document into its final form. Translates document (a Docutils document tree) into the Writer’s …

write

LatexWriterWithCustomDirectives

Processes a document into its final form. Translates document (a Docutils document tree) into the Writer’s …

write

MDWriterWithCustomDirectives

Processes a document into its final form. Translates document (a Docutils document tree) into the Writer’s …

write

RSTWriterWithCustomDirectives

Processes a document into its final form. Translates document (a Docutils document tree) into the Writer’s …

write

_WriterWithCustomDirectives

Processes a document into its final form. Translates document (a Docutils document tree) into the Writer’s …

write

LogFakeFileStream

does nothing

write

LogFileStream

does nothing

write

StringIOAndFile

Appends a string.

write

CustomizedSphinxFileOutput

write

EnhancedLaTeXBuilder

write_aggregated

BlogPostList

Writes posts in a aggregated manner (post, categories, months).

write_aggregated_categories

BlogPostList

Writes posts in a aggregated manner per categories.

write_aggregated_chapters

BlogPostList

Writes links to post per categories and per months.

write_aggregated_index

BlogPostList

Writes an index.

write_aggregated_months

BlogPostList

Writes posts in a aggregated manner per months.

write_aggregated_posts

BlogPostList

Writes posts in a aggregated manner.

write_doc

DocTreeBuilder

write_doc

MdBuilder

write_doc

RstBuilder

write_file

ExtTestCase

Writes the content of a file.

write_stylesheet

MemoryLatexBuilder