The sphinx_readme.utils.docutils submodule

sphinx_readme.utils.docutils.get_doctree(app, rst, docname='index')View on GitHub

View Source Code

def get_doctree(app: Sphinx, rst: str, docname: str = 'index') -> nodes.document:
    """Generate doctree from a string of reStructuredText using Sphinx application."""
    try:
        app.env.temp_data['docname'] = docname
        return publish_doctree(rst, settings_overrides={
            'env': app.env,
            'gettext_compact': True,
            "report_level": 4,
            "halt_level": 5
        })
    finally:
        app.env.temp_data.pop('docname', None)

Generate doctree from a string of reStructuredText using Sphinx application.

Return type

document

sphinx_readme.utils.docutils.parse_node_text(node)View on GitHub

View Source Code

def parse_node_text(node: nodes.Node) -> str:
    """Parses the text from a node, preserving inline literals"""
    parts = []
    for child in node.children:
        text = child.astext()
        if isinstance(child, nodes.literal):
            parts.append(f"``{text}``")
        else:
            parts.append(text)
    return ' '.join(parts)

Parses the text from a node, preserving inline literals

Return type

str