lib.writers

Docutils writers for Django Docutils, designed for cleaner output.

class django_docutils.lib.writers.ParentNodeClassTuple

class

Bases: NamedTuple

Typing for parent node accepting custom arguments.

parent_node_type: type[Node | Body]

attribute

Alias for field number 0

args: list[str]

attribute

Alias for field number 1

kwargs: dict[str, str]

attribute

Alias for field number 2

close_tag: str | None

attribute

Alias for field number 3

static __new__(_cls, parent_node_type, args, kwargs, close_tag)

staticmethod method

Create new instance of ParentNodeClassTuple(parent_node_type, args, kwargs, close_tag)

Parameters:

• parent_node_type (type[nodes.Node | nodes.Body])

• args (list[str])

• kwargs (dict[str, str])

• close_tag (str | None)

_asdict()

method

Return a new dict which maps field names to their values.

_field_defaults = {}

attribute

_fields = ('parent_node_type', 'args', 'kwargs', 'close_tag')

attribute

classmethod _make(iterable)

classmethod method

Make a new ParentNodeClassTuple object from a sequence or iterable

_replace(**kwds)

method

Return a new ParentNodeClassTuple object replacing specified fields with new values

class django_docutils.lib.writers.DjangoDocutilsHTMLTranslator

class

Bases: HTMLTranslator

Django Docutils touchups to docutil’s HTML renderer.

__init__(document)

method

Parameters:

document (document)

Return type:

None

visit_table(node)

method

Open table.

Parameters:

node (Element)

Return type:

None

visit_reference(node)

method

Open reference.

Changes:

• Monkeypatch bugfix https://sourceforge.net/p/docutils/bugs/322/

• Add target _blank to offsite urls

• Add class offsite for offsite urls

• Add class insite for insite urls (note, internal is already used for reference links in the same document)

Parameters:

node (Element)

Return type:

None

visit_title(node)

method

Visit docutils title.

Changes:

• Add backlinks for Contents refid headers

  They’re baked inside the Section (parent) of the anchor since we’re using an ad-hoc contents transformation process that builds toc separately from the main content (see templatetags)

• s/with-subtitle/subtitle for bulma css

Parameters:

node (Element)

Return type:

None

_visit_section_title(node, close_tag)

method

Our special sauce for section titles.

Extracted from visit_title() to reduce complexity.

Parameters:

• node (docutils.nodes.title) – Title node being visited

• close_tag (str) – Close tag (passed in from visit_title)

Returns:

Close tag for section title node.

Return type:

str

visit_docinfo(node)

method

Skip docinfo.

Parameters:

node (Element)

Return type:

None

visit_icon(node)

method

Open <em> tag.

Parameters:

node (decoration)

Return type:

None

depart_icon(node)

method

Close <em> tag.

Parameters:

node (decoration)

Return type:

None

class django_docutils.lib.writers.DjangoDocutilsWriter

class

Bases: Writer

DjangoDocutils’s hand-crafted docutils’ writer.

Example:

>>> DJANGO_DOCUTILS_LIB_RST = {
...    'transforms': [  #: docutils.transforms.Transform class (import string)
...        'django_docutils.lib.transforms.xref.XRefTransform'
...    ]
... }

__init__()

method

Return type:

None

get_transforms()

method

Return transformed required by DjangoDocutilsWriter.

Adheres to DJANGO_DOCUTILS_LIB_RST settings.

Return type:

list[type[Transform]]