Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

miscellaneous

Other directives.

class rstobj.directives.miscellaneous.Include(class_: Optional[str] = None, name: Optional[str] = None, path: Optional[str] = None, start_line: Optional[int] = None, end_line: Optional[int] = None, start_after: Optional[str] = None, end_before: Optional[str] = None, literal: Optional[bool] = None, code: Optional[str] = None, number_lines: Optional[int] = None, encoding: Optional[str] = None, tab_width: Optional[int] = None)

.. include:: directive. Include an external document fragment.

Example:

inc = Include(path="README.rst")
inc.render()

Output:

.. include:: README.rst

Parameters definition see here http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment.