.. _l-properties:

Properties
==========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| property                                                                                                                                | class parent                        | truncated documentation                                                                                                     |
+=========================================================================================================================================+=====================================+=============================================================================================================================+
| :meth:`Appendix <pyquickhelper.benchhelper.benchmark.BenchMark.Appendix>`                                                               | BenchMark                           | Returns the metrics.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Appendix <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Appendix>`                                                      | GridBenchMark                       | Returns the metrics.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Author <pyquickhelper.sphinxext.blog_post.BlogPost.Author>`                                                                      | BlogPost                            | Returns the author or None if not defined.                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`BlogBackground <pyquickhelper.sphinxext.blog_post.BlogPost.BlogBackground>`                                                      | BlogPost                            | Returns the blog background or None if not defined.                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Categories <pyquickhelper.sphinxext.blog_post.BlogPost.Categories>`                                                              | BlogPost                            | Returns the categories.                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Content <pyquickhelper.sphinxext.blog_post.BlogPost.Content>`                                                                    | BlogPost                            | Returns the content of the blogpost.                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class.MagicClassWithHelpers.Context>`                                                 | MagicClassWithHelpers               | return the context or None                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.Context>`                                                | MagicCompress                       | return the context or None                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.Context>`                                                      | MagicCrypt                          | return the context or None                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.Context>`                                                        | MagicDiff                           | return the context or None                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.Context>`                                             | MagicClassExample                   | return the context or None                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Date <pyquickhelper.sphinxext.blog_post.BlogPost.Date>`                                                                          | BlogPost                            | Returns the date.                                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Engines <pyquickhelper.jenkinshelper.jenkins_server.JenkinsExt.Engines>`                                                         | JenkinsExt                          |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Fields <pyquickhelper.sphinxext.blog_post.BlogPost.Fields>`                                                                      | BlogPost                            | Returns the fields as a dictionary.                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`FileName <pyquickhelper.sphinxext.blog_post.BlogPost.FileName>`                                                                  | BlogPost                            | Returns the filename.                                                                                                       |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Graphs <pyquickhelper.benchhelper.benchmark.BenchMark.Graphs>`                                                                   | BenchMark                           | Returns images of graphs.                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Graphs <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Graphs>`                                                          | GridBenchMark                       | Returns images of graphs.                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Keywords <pyquickhelper.sphinxext.blog_post.BlogPost.Keywords>`                                                                  | BlogPost                            | Returns the keywords.                                                                                                       |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Lang <pyquickhelper.sphinxext.blog_post_list.BlogPostList.Lang>`                                                                 | BlogPostList                        | Returns the language.                                                                                                       |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Mapping <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.Mapping>`                                                     | EncryptedBackup                     | returns the mapping                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Metadata <pyquickhelper.benchhelper.benchmark.BenchMark.Metadata>`                                                               | BenchMark                           | Returns the metrics.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Metadata <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Metadata>`                                                      | GridBenchMark                       | Returns the metrics.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Metrics <pyquickhelper.benchhelper.benchmark.BenchMark.Metrics>`                                                                 | BenchMark                           | Returns the metrics.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Metrics <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Metrics>`                                                        | GridBenchMark                       | Returns the metrics.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Name <pyquickhelper.benchhelper.benchmark.BenchMark.Name>`                                                                       | BenchMark                           | Returns the name of the benchmark.                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Name <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Name>`                                                              | GridBenchMark                       | Returns the name of the benchmark.                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Site <pyquickhelper.filehelper.ftp_mock.MockTransferFTP.Site>`                                                                   | MockTransferFTP                     | return the website                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Site <pyquickhelper.filehelper.ftp_transfer.TransferFTP.Site>`                                                                   | TransferFTP                         | return the website                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Site <pyquickhelper.filehelper.ftp_transfer_mock.MockTransferFTP.Site>`                                                          | MockTransferFTP                     | return the website                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Tag <pyquickhelper.sphinxext.blog_post.BlogPost.Tag>`                                                                            | BlogPost                            | Produces a tag for the blog post.                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Title <pyquickhelper.sphinxext.blog_post.BlogPost.Title>`                                                                        | BlogPost                            | Returns the title.                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Year <pyquickhelper.sphinxext.blog_post.BlogPost.Year>`                                                                          | BlogPost                            | Returns the year, we assume ``self.date`` is a string like ``YYYY-MM-DD``.                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_ <pyquickhelper.ipythonhelper.kindofcompletion.AutoCompletion._>`                                                            | AutoCompletion                      | return the value                                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_ <pyquickhelper.ipythonhelper.kindofcompletion.AutoCompletionFile._>`                                                        | AutoCompletionFile                  | return the value                                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_members <pyquickhelper.ipythonhelper.kindofcompletion.AutoCompletion._members>`                                              | AutoCompletion                      | returns all the members                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_members <pyquickhelper.ipythonhelper.kindofcompletion.AutoCompletionFile._members>`                                          | AutoCompletionFile                  | returns all the members                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`classname <pyquickhelper.helpgen.utils_sphinx_doc_helpers.ModuleMemberDoc.classname>`                                            | ModuleMemberDoc                     | Returns the class name if the object is a method.                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`comment <pyquickhelper.filehelper.winzipfile.WinZipFile.comment>`                                                                | WinZipFile                          | The comment text associated with the ZIP file.                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`config <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree.config>`                                                  | CustomTocTree                       | Reference to the :class:`.Config` object.                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.helpgen._nbconvert_preprocessor.LatexRawOutputPreprocessor.cross_validation_lock>`          | LatexRawOutputPreprocessor          | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter.cross_validation_lock>`                       | UpgradedRSTExporter                 | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class.MagicClassWithHelpers.cross_validation_lock>`                     | MagicClassWithHelpers               | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.cross_validation_lock>`                    | MagicCompress                       | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.cross_validation_lock>`                          | MagicCrypt                          | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.cross_validation_lock>`                            | MagicDiff                           | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.cross_validation_lock>`                 | MagicClassExample                   | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`daemon <pyquickhelper.loghelper.run_cmd._AsyncLineReader.daemon>`                                                                | _AsyncLineReader                    | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`daemon <pyquickhelper.server.documentation_server.DocumentationThreadServer.daemon>`                                             | DocumentationThreadServer           | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`date <pyquickhelper.filehelper.file_tree_node.FileTreeNode.date>`                                                                | FileTreeNode                        | Returns the modification date.                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`default_config <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter.default_config>`                                     | UpgradedRSTExporter                 |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`default_translator_class <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.default_translator_class>` | CustomSingleFileHTMLBuilder         |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`docname <pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper._CustomBuildEnvironment.docname>`                               | _CustomBuildEnvironment             | Returns the docname of the document currently being parsed.                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.revealjs.document>`                                                        | revealjs                            | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.rv_code.document>`                                                         | rv_code                             | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.rv_note.document>`                                                         | rv_note                             | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.rv_small.document>`                                                        | rv_small                            | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_autosignature.autosignature_node.document>`                                             | autosignature_node                  | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_bigger_extension.bigger_node.document>`                                                 | bigger_node                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_blocref_extension.blocref_node.document>`                                               | blocref_node                        | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_blocref_extension.blocreflist.document>`                                                | blocreflist                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_blog_extension.blogpost_node.document>`                                                 | blogpost_node                       | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_blog_extension.blogpostagg_node.document>`                                              | blogpostagg_node                    | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_blog_extension.blogpostlist_node.document>`                                             | blogpostlist_node                   | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_cmdref_extension.cmdref_node.document>`                                                 | cmdref_node                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_cmdref_extension.cmdreflist.document>`                                                  | cmdreflist                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_collapse_extension.collapse_node.document>`                                             | collapse_node                       | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_downloadlink_extension.downloadlink_node.document>`                                     | downloadlink_node                   | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_epkg_extension.epkg_node.document>`                                                     | epkg_node                           | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_exref_extension.exref_node.document>`                                                   | exref_node                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_exref_extension.exreflist.document>`                                                    | exreflist                           | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_faqref_extension.faqref_node.document>`                                                 | faqref_node                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_faqref_extension.faqreflist.document>`                                                  | faqreflist                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_gdot_extension.gdot_node.document>`                                                     | gdot_node                           | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_githublink_extension.githublink_node.document>`                                         | githublink_node                     | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_gitlog_extension.gitlog_node.document>`                                                 | gitlog_node                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_image_extension.simpleimage_node.document>`                                             | simpleimage_node                    | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_mathdef_extension.mathdef_node.document>`                                               | mathdef_node                        | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_mathdef_extension.mathdeflist.document>`                                                | mathdeflist                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_nbref_extension.nbref_node.document>`                                                   | nbref_node                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_nbref_extension.nbreflist.document>`                                                    | nbreflist                           | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_postcontents_extension.postcontents_node.document>`                                     | postcontents_node                   | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_quote_extension.quote_node.document>`                                                   | quote_node                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_runpython_extension.runpython_node.document>`                                           | runpython_node                      | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_sharenet_extension.sharenet_node.document>`                                             | sharenet_node                       | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_template_extension.tpl_node.document>`                                                  | tpl_node                            | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_tocdelay_extension.tocdelay_node.document>`                                             | tocdelay_node                       | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_todoext_extension.todoext_node.document>`                                               | todoext_node                        | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_todoext_extension.todoextlist.document>`                                                | todoextlist                         | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_video_extension.video_node.document>`                                                   | video_node                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinx_youtube_extension.youtube_node.document>`                                               | youtube_node                        | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.gallery_node.document>`                                         | gallery_node                        | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.image_node.document>`                                           | image_node                          | Return the `document` root node of the tree containing this Node.                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`env <pyquickhelper.sphinxext.sphinx_toctree_extension.CustomTocTree.env>`                                                        | CustomTocTree                       | Reference to the :class:`.BuildEnvironment` object.                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`environment <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter.environment>`                                           | UpgradedRSTExporter                 |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`extensions <pyquickhelper.helpgen.sphinxm_mock_app.MockSphinxApp.extensions>`                                                    | MockSphinxApp                       |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`filename <pyquickhelper.loghelper.custom_log.CustomLog.filename>`                                                                | CustomLog                           | returns *_filename*                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`found_docs <pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper._CustomBuildEnvironment.found_docs>`                         | _CustomBuildEnvironment             | contains all existing docnames.                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`fullname <pyquickhelper.filehelper.file_tree_node.FileTreeNode.fullname>`                                                        | FileTreeNode                        | Returns the full name.                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`fullpath <pyquickhelper.loghelper.custom_log.CustomLog.fullpath>`                                                                | CustomLog                           | returns *_fullpath*                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`ident <pyquickhelper.loghelper.run_cmd._AsyncLineReader.ident>`                                                                  | _AsyncLineReader                    | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ...     |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`ident <pyquickhelper.server.documentation_server.DocumentationThreadServer.ident>`                                               | DocumentationThreadServer           | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ...     |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`key <pyquickhelper.helpgen.utils_sphinx_doc_helpers.ModuleMemberDoc.key>`                                                        | ModuleMemberDoc                     | Returns a key to identify it.                                                                                               |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`key <pyquickhelper.pycode.profiling.ProfileNode.key>`                                                                            | ProfileNode                         | Returns `file:line`.                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`math_renderer_name <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.math_renderer_name>`             | CustomSingleFileHTMLBuilder         |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`math_renderer_name <pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper.MemoryHTMLBuilder.math_renderer_name>`               | MemoryHTMLBuilder                   |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <pyquickhelper.filehelper.file_tree_node.FileTreeNode.name>`                                                                | FileTreeNode                        | Returns the file name from the root.                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <pyquickhelper.loghelper.run_cmd._AsyncLineReader.name>`                                                                    | _AsyncLineReader                    | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ...       |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <pyquickhelper.server.documentation_server.DocumentationThreadServer.name>`                                                 | DocumentationThreadServer           | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ...       |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`native_id <pyquickhelper.loghelper.run_cmd._AsyncLineReader.native_id>`                                                          | _AsyncLineReader                    | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ...           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`native_id <pyquickhelper.server.documentation_server.DocumentationThreadServer.native_id>`                                       | DocumentationThreadServer           | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ...           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`prop <pyquickhelper.sphinxext.import_object_helper._Types.prop>`                                                                 | _Types                              |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`root <pyquickhelper.filehelper.file_tree_node.FileTreeNode.root>`                                                                | FileTreeNode                        | Returns the root directory, the one used as a root for a synchronization.                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`size <pyquickhelper.filehelper.file_tree_node.FileTreeNode.size>`                                                                | FileTreeNode                        | Returns the size.                                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`table <pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper.LatexTranslatorWithCustomDirectives.table>`                       | LatexTranslatorWithCustomDirectives | Get current table.                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`table <pyquickhelper.sphinxext.sphinx_latex_builder.EnhancedLaTeXTranslator.table>`                                              | EnhancedLaTeXTranslator             | Get current table.                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`template <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter.template>`                                                 | UpgradedRSTExporter                 |                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`truncdoc <pyquickhelper.helpgen.utils_sphinx_doc_helpers.IndexInformation.truncdoc>`                                             | IndexInformation                    | Returns ``self.text``.                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`type <pyquickhelper.filehelper.file_tree_node.FileTreeNode.type>`                                                                | FileTreeNode                        | Returns the file type (``file`` or ``folder``).                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+