module sphinxext.revealjs.directives

Inheritance diagram of pyquickhelper.sphinxext.revealjs.directives

Short summary

module pyquickhelper.sphinxext.revealjs.directives

author

tell-k <ffk2005@gmail.com>

copyright

tell-k. All Rights Reserved.

source on GitHub

Classes

class

truncated documentation

revealjs

node for revealjs

RevealjsDirective

Reveal.JS slide entry

rv_code

node for revealjs code section

rv_note

node for revealjs presentation note

rv_small

node for revealjs small text section

RvCodeDirective

Directive for a code block with highlight.js

RvNoteDirective

Directive for a notes tag.

RvSmallDirective

Create small text tag.

Functions

function

truncated documentation

depart_revealjs

build end tag for revealjs

depart_rv_code

build end tag for rv_code

depart_rv_note

build end tag for rv_note

depart_rv_small

build end tag for rv_small

heading

directives choices for heading tag

setup

Initialize

visit_revealjs

build start tag for revealjs

visit_rv_code

build start tag for rv_code

visit_rv_note

build start tag for rv_note

visit_rv_small

build start tag for rv_small

Methods

method

truncated documentation

run

build revealjs node

run

build rv_code node

run

build rv_note node

run

build rv_small node

Documentation

sphinxjp.themes.revealjs.directives

author

tell-k <ffk2005@gmail.com>

copyright

tell-k. All Rights Reserved.

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.RevealjsDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source][source]

Bases: docutils.parsers.rst.Directive

Reveal.JS slide entry

source on GitHub

node_class[source]

alias of revealjs

run()[source][source]

build revealjs node

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.RvCodeDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source][source]

Bases: docutils.parsers.rst.Directive

Directive for a code block with highlight.js

source on GitHub

node_class[source]

alias of rv_code

run()[source][source]

build rv_code node

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.RvNoteDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source][source]

Bases: docutils.parsers.rst.Directive

Directive for a notes tag.

source on GitHub

node_class[source]

alias of rv_note

run()[source][source]

build rv_note node

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.RvSmallDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source][source]

Bases: docutils.parsers.rst.Directive

Create small text tag.

source on GitHub

node_class[source]

alias of rv_small

run()[source][source]

build rv_small node

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.depart_revealjs(self, node=None)[source][source]

build end tag for revealjs

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.depart_rv_code(self, node=None)[source][source]

build end tag for rv_code

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.depart_rv_note(self, node=None)[source][source]

build end tag for rv_note

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.depart_rv_small(self, node=None)[source][source]

build end tag for rv_small

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.heading(argument)[source][source]

directives choices for heading tag

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.revealjs(rawsource='', *children, **attributes)[source][source]

Bases: docutils.nodes.General, docutils.nodes.Element

node for revealjs

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.rv_code(rawsource='', *children, **attributes)[source][source]

Bases: docutils.nodes.General, docutils.nodes.Element

node for revealjs code section

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.rv_note(rawsource='', *children, **attributes)[source][source]

Bases: docutils.nodes.General, docutils.nodes.Element

node for revealjs presentation note

source on GitHub

class pyquickhelper.sphinxext.revealjs.directives.rv_small(rawsource='', *children, **attributes)[source][source]

Bases: docutils.nodes.General, docutils.nodes.Element

node for revealjs small text section

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.setup(app)[source][source]

Initialize

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.visit_revealjs(self, node)[source][source]

build start tag for revealjs

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.visit_rv_code(self, node)[source][source]

build start tag for rv_code

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.visit_rv_note(self, node)[source][source]

build start tag for rv_note

source on GitHub

pyquickhelper.sphinxext.revealjs.directives.visit_rv_small(self, node)[source][source]

build start tag for rv_small

source on GitHub