Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

codeblock

code block related directives.

class rstobj.directives.codeblock.Code(text: Optional[str] = None)

Pure text code Snippet.

class rstobj.directives.codeblock.CodeBlockEmpty(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Example:

code = "your code ..."
cb = CodeBlockEmpty.from_string(code)
cb.render()

Output:

::

    your code ...

classmethod from_string(text: str)

Construct CodeBlock from string.

class rstobj.directives.codeblock.CodeBlockBase(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Base class for language specified code block.

class LangOptions

Full list can be found here https://pygments.org/docs/lexers/

property template_name

Find template file.

Return type

str

class rstobj.directives.codeblock.CodeBlock(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: 

    your code ...

class rstobj.directives.codeblock.CodeBlockPython(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: python

    your code ...

class rstobj.directives.codeblock.CodeBlockRuby(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: ruby

    your code ...

class rstobj.directives.codeblock.CodeBlockR(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: r

    your code ...

class rstobj.directives.codeblock.CodeBlockPerl(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: perl

    your code ...

class rstobj.directives.codeblock.CodeBlockC(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: c

    your code ...

class rstobj.directives.codeblock.CodeBlockCPP(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: cpp

    your code ...

class rstobj.directives.codeblock.CodeBlockHTML(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: html

    your code ...

class rstobj.directives.codeblock.CodeBlockCSS(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: css

    your code ...

class rstobj.directives.codeblock.CodeBlockJavaScript(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: javascript

    your code ...

class rstobj.directives.codeblock.CodeBlockSQL(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: sql

    your code ...

class rstobj.directives.codeblock.CodeBlockScala(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: scala

    your code ...

class rstobj.directives.codeblock.CodeBlockMake(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: make

    your code ...

class rstobj.directives.codeblock.CodeBlockBash(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: bash

    your code ...

class rstobj.directives.codeblock.CodeBlockLua(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: lua

    your code ...

class rstobj.directives.codeblock.CodeBlockRst(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: ReST

    your code ...

class rstobj.directives.codeblock.CodeBlockMarkdown(class_: Optional[str] = None, name: Optional[str] = None, code=None)

Parameters

code – Code.

Example:

code = "your code ..."
cb = CodeBlockLanguageName.from_string(code)
cb.render()

Output:

.. code-block: md

    your code ...