module sphinxext.revealjs.directives
¶
Short summary¶
module pyquickhelper.sphinxext.revealjs.directives
- author:
tell-k <ffk2005@gmail.com>
- copyright:
tell-k. All Rights Reserved.
Classes¶
class |
truncated documentation |
---|---|
node for revealjs |
|
Reveal.JS slide entry |
|
node for revealjs code section |
|
node for revealjs presentation note |
|
node for revealjs small text section |
|
Directive for a code block with highlight.js |
|
Directive for a notes tag. |
|
Create small text tag. |
Functions¶
function |
truncated documentation |
---|---|
build end tag for revealjs |
|
build end tag for rv_code |
|
build end tag for rv_note |
|
build end tag for rv_small |
|
directives choices for heading tag |
|
Initialize |
|
build start tag for revealjs |
|
build start tag for rv_code |
|
build start tag for rv_note |
|
build start tag for rv_small |
Properties¶
property |
truncated documentation |
---|---|
|
Return the document root node of the tree containing this Node. |
|
Return the document root node of the tree containing this Node. |
|
Return the document root node of the tree containing this Node. |
|
Return the document root node of the tree containing this Node. |
Methods¶
method |
truncated documentation |
---|---|
build revealjs node |
|
build rv_code node |
|
build rv_note node |
|
build rv_small node |
Documentation¶
sphinxjp.themes.revealjs.directives¶
- author:
tell-k <ffk2005@gmail.com>
- copyright:
tell-k. All Rights Reserved.
- class pyquickhelper.sphinxext.revealjs.directives.RevealjsDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
Reveal.JS slide entry
- option_spec = {'class': <function class_option>, 'data-autoslide': <function unchanged>, 'data-background': <function unchanged>, 'data-background-repeat': <function unchanged>, 'data-background-size': <function unchanged>, 'data-background-transition': <function unchanged>, 'data-charset': <function unchanged>, 'data-markdown': <function unchanged>, 'data-separator': <function unchanged>, 'data-separator-notes': <function unchanged>, 'data-separator-vertical': <function unchanged>, 'data-state': <function unchanged>, 'data-transition': <function unchanged>, 'data-transition-speed': <function unchanged>, 'id': <function unchanged>, 'noheading': <function flag>, 'subtitle': <function unchanged>, 'subtitle-heading': <function unchanged>, 'title-heading': <function heading>}[source]¶
Mapping of option names to validator functions.
- class pyquickhelper.sphinxext.revealjs.directives.RvCodeDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
Directive for a code block with highlight.js
- option_spec = {'class': <function class_option>, 'id': <function unchanged>}[source]¶
Mapping of option names to validator functions.
- class pyquickhelper.sphinxext.revealjs.directives.RvNoteDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
Directive for a notes tag.
- option_spec = {'class': <function class_option>}[source]¶
Mapping of option names to validator functions.
- class pyquickhelper.sphinxext.revealjs.directives.RvSmallDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
Create small text tag.
- option_spec = {'class': <function class_option>}[source]¶
Mapping of option names to validator functions.
- pyquickhelper.sphinxext.revealjs.directives.depart_revealjs(self, node=None)[source]¶
build end tag for revealjs
- pyquickhelper.sphinxext.revealjs.directives.depart_rv_code(self, node=None)[source]¶
build end tag for rv_code
- pyquickhelper.sphinxext.revealjs.directives.depart_rv_note(self, node=None)[source]¶
build end tag for rv_note
- pyquickhelper.sphinxext.revealjs.directives.depart_rv_small(self, node=None)[source]¶
build end tag for rv_small
- pyquickhelper.sphinxext.revealjs.directives.heading(argument)[source]¶
directives choices for heading tag
- class pyquickhelper.sphinxext.revealjs.directives.revealjs(rawsource='', *children, **attributes)[source]¶
Bases:
General
,Element
node for revealjs
- class pyquickhelper.sphinxext.revealjs.directives.rv_code(rawsource='', *children, **attributes)[source]¶
Bases:
General
,Element
node for revealjs code section
- class pyquickhelper.sphinxext.revealjs.directives.rv_note(rawsource='', *children, **attributes)[source]¶
Bases:
General
,Element
node for revealjs presentation note
- class pyquickhelper.sphinxext.revealjs.directives.rv_small(rawsource='', *children, **attributes)[source]¶
Bases:
General
,Element
node for revealjs small text section
- pyquickhelper.sphinxext.revealjs.directives.visit_revealjs(self, node)[source]¶
build start tag for revealjs
- pyquickhelper.sphinxext.revealjs.directives.visit_rv_code(self, node)[source]¶
build start tag for rv_code
- pyquickhelper.sphinxext.revealjs.directives.visit_rv_note(self, node)[source]¶
build start tag for rv_note