Skip to content

chunklet.document_chunker.converters.rst_2_md

Functions:

  • rst_to_md –

    Converts reStructuredText (RST) content into Markdown.

rst_to_md 

rst_to_md(file_path: str | Path) -> str

Converts reStructuredText (RST) content into Markdown.

Parameters:

  • file_path

    (str | Path) –

    Path to the rst file.

Returns:

  • str ( str ) –

    The full text content in Markdown.

Source code in src/chunklet/document_chunker/converters/rst_2_md.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def rst_to_md(file_path: str | Path) -> str:
    """
    Converts reStructuredText (RST) content into Markdown.

    Args:
        file_path (str | Path): Path to the rst file.

    Returns:
        str: The full text content in Markdown.
    """
    if publish_string is None:
        raise ImportError(
            "The 'docutils' library is not installed. "
            "Please install it with 'pip install 'docutils>=0.21.2'' or install the document processing extras "
            "with 'pip install 'chunklet-py[document]''"
        )

    with open(file_path, "r", encoding="utf-8", errors="ignore") as f:
        rst_content = f.read()

    # Convert the rst content to HTML first
    html_content = publish_string(source=rst_content, writer_name="html").decode(
        "utf-8"
    )

    # Now we can convert it to markdown
    markdown_content = html_to_md(raw_text=html_content)
    return markdown_content