.. _f-directives:

module ``sphinxext.revealjs.directives``
========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.revealjs.directives


Short summary
+++++++++++++

module ``pyquickhelper.sphinxext.revealjs.directives``

    sphinxjp.themes.revealjs.directives
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    :author: tell-k <ffk2005@gmail.com>
    :copyright: tell-k. All Rights Reserved.


    :githublink:`%|py|9`




Classes
+++++++

+--------------------------------------------------------------------------------------------+----------------------------------------------+
| class                                                                                      | truncated documentation                      |
+============================================================================================+==============================================+
| :class:`revealjs <pyquickhelper.sphinxext.revealjs.directives.revealjs>`                   | node for revealjs                            |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`RevealjsDirective <pyquickhelper.sphinxext.revealjs.directives.RevealjsDirective>` | Reveal.JS slide entry                        |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`rv_code <pyquickhelper.sphinxext.revealjs.directives.rv_code>`                     | node for revealjs code section               |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`rv_note <pyquickhelper.sphinxext.revealjs.directives.rv_note>`                     | node for revealjs presentation note          |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`rv_small <pyquickhelper.sphinxext.revealjs.directives.rv_small>`                   | node for revealjs small text section         |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`RvCodeDirective <pyquickhelper.sphinxext.revealjs.directives.RvCodeDirective>`     | Directive for a code block with highlight.js |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`RvNoteDirective <pyquickhelper.sphinxext.revealjs.directives.RvNoteDirective>`     | Directive for a notes tag.                   |
+--------------------------------------------------------------------------------------------+----------------------------------------------+
| :class:`RvSmallDirective <pyquickhelper.sphinxext.revealjs.directives.RvSmallDirective>`   | Create small text tag.                       |
+--------------------------------------------------------------------------------------------+----------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------+------------------------------------+
| function                                                                              | truncated documentation            |
+=======================================================================================+====================================+
| :func:`depart_revealjs <pyquickhelper.sphinxext.revealjs.directives.depart_revealjs>` | build end tag for revealjs         |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`depart_rv_code <pyquickhelper.sphinxext.revealjs.directives.depart_rv_code>`   | build end tag for rv_code          |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`depart_rv_note <pyquickhelper.sphinxext.revealjs.directives.depart_rv_note>`   | build end tag for rv_note          |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`depart_rv_small <pyquickhelper.sphinxext.revealjs.directives.depart_rv_small>` | build end tag for rv_small         |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`heading <pyquickhelper.sphinxext.revealjs.directives.heading>`                 | directives choices for heading tag |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.revealjs.directives.setup>`                     | Initialize                         |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`visit_revealjs <pyquickhelper.sphinxext.revealjs.directives.visit_revealjs>`   | build start tag for revealjs       |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`visit_rv_code <pyquickhelper.sphinxext.revealjs.directives.visit_rv_code>`     | build start tag for rv_code        |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`visit_rv_note <pyquickhelper.sphinxext.revealjs.directives.visit_rv_note>`     | build start tag for rv_note        |
+---------------------------------------------------------------------------------------+------------------------------------+
| :func:`visit_rv_small <pyquickhelper.sphinxext.revealjs.directives.visit_rv_small>`   | build start tag for rv_small       |
+---------------------------------------------------------------------------------------+------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------------+-------------------------------------------------------------------+
| property                                                                         | truncated documentation                                           |
+==================================================================================+===================================================================+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.revealjs.document>` | Return the `document` root node of the tree containing this Node. |
+----------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.rv_code.document>`  | Return the `document` root node of the tree containing this Node. |
+----------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.rv_note.document>`  | Return the `document` root node of the tree containing this Node. |
+----------------------------------------------------------------------------------+-------------------------------------------------------------------+
| :meth:`document <pyquickhelper.sphinxext.revealjs.directives.rv_small.document>` | Return the `document` root node of the tree containing this Node. |
+----------------------------------------------------------------------------------+-------------------------------------------------------------------+






Methods
+++++++

+---------------------------------------------------------------------------------+-------------------------+
| method                                                                          | truncated documentation |
+=================================================================================+=========================+
| :meth:`run <pyquickhelper.sphinxext.revealjs.directives.RevealjsDirective.run>` | build revealjs node     |
+---------------------------------------------------------------------------------+-------------------------+
| :meth:`run <pyquickhelper.sphinxext.revealjs.directives.RvCodeDirective.run>`   | build rv_code node      |
+---------------------------------------------------------------------------------+-------------------------+
| :meth:`run <pyquickhelper.sphinxext.revealjs.directives.RvNoteDirective.run>`   | build rv_note node      |
+---------------------------------------------------------------------------------+-------------------------+
| :meth:`run <pyquickhelper.sphinxext.revealjs.directives.RvSmallDirective.run>`  | build rv_small node     |
+---------------------------------------------------------------------------------+-------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.sphinxext.revealjs.directives
    :members:
    :special-members: __init__
    :show-inheritance: