pkgcore.util.rst2devbook module

A docutils’s writer for DevBook format [1]

[1]

https://devmanual.gentoo.org/appendices/devbook-guide/index.html

class pkgcore.util.rst2devbook.DevBookTranslator(document: document, eclass: str)

Bases: NodeVisitor

A docutils translator for DevBook.

astext() → str

depart_Text(node)

depart_attention(*a, **kw)

Method alias to invoke depart_important().

depart_attribution(node)

depart_block_quote(node)

depart_bullet_list(node)

depart_caution(*a, **kw)

Method alias to invoke depart_important().

depart_danger(*a, **kw)

Method alias to invoke depart_warning().

depart_definition(node)

depart_definition_list(node)

depart_definition_list_item(node)

depart_document(node)

depart_emphasis(node)

depart_entry(node)

depart_enumerated_list(node)

depart_error(*a, **kw)

Method alias to invoke depart_warning().

depart_field(node)

depart_field_body(node)

depart_field_list(node)

depart_field_name(node)

depart_hint(*a, **kw)

Method alias to invoke depart_note().

depart_important(node)

depart_line(node)

depart_line_block(node)

depart_list_item(node)

depart_literal(node)

depart_literal_block(node)

depart_note(node)

depart_paragraph(node)

depart_problematic(node)

depart_reference(node)

depart_row(node)

depart_rubric(node)

depart_section(node)

depart_strong(node)

depart_table(node)

depart_tbody(node)

depart_term(node)

depart_tgroup(node)

depart_thead(node)

depart_tip(*a, **kw)

Method alias to invoke depart_note().

depart_title(node)

depart_title_reference(node)

depart_warning(node)

sections_tags = ('section', 'subsection', 'subsubsection')

unknown_departure(node)

Called before exiting unknown Node types.

Raise exception unless overridden.

unknown_visit(node)

Render a node DevBook has no element for, rather than failing.

eclassdoc prose is written by hand, and one eclass reaching for reST that doesn’t map onto DevBook shouldn’t cost the whole run. A node holding blocks of its own gives way to them; a leaf’s text needs a p to live in, since body holds block elements only.

visit_Text(node)

visit_attention(*a, **kw)

Method alias to invoke visit_important().

visit_attribution(node)

visit_block_quote(node)

visit_bullet_list(node)

visit_caution(*a, **kw)

Method alias to invoke visit_important().

visit_colspec(node)

visit_comment(node)

visit_danger(*a, **kw)

Method alias to invoke visit_warning().

visit_definition(node)

visit_definition_list(node)

visit_definition_list_item(node)

visit_doctest_block(node)

visit_document(node)

visit_emphasis(node)

visit_entry(node)

visit_enumerated_list(node)

visit_error(*a, **kw)

Method alias to invoke visit_warning().

visit_field(node)

visit_field_body(node)

visit_field_list(node)

visit_field_name(node)

visit_hint(*a, **kw)

Method alias to invoke visit_note().

visit_important(node)

visit_line(node)

visit_line_block(node)

visit_list_item(node)

visit_literal(node)

visit_literal_block(node)

visit_note(node)

visit_paragraph(node)

visit_problematic(node)

Render markup docutils choked on as the plain text it was written as.

visit_raw(node)

visit_reference(node)

visit_row(node)

visit_rubric(node)

visit_section(node)

visit_strong(node)

visit_substitution_definition(node)

visit_system_message(node)

Drop the diagnostic docutils attached to a problematic node.

visit_table(node)

visit_tbody(node)

visit_term(node)

visit_tgroup(node)

visit_thead(node)

visit_tip(*a, **kw)

Method alias to invoke visit_note().

visit_title(node)

visit_title_reference(node)

visit_warning(node)

class pkgcore.util.rst2devbook.DevBookWriter(eclass)

Bases: Writer

A docutils writer for DevBook.

translate()

Call the translator to translate the document