deepcave.utils.docs

# Docs

This module provides a function to convert reStructuredText (RST) to MarkDown (MD).

Functions

rst_to_md(filename)

Convert a subset of reStructuredText (RST) to MarkDown (MD).

deepcave.utils.docs.rst_to_md(filename)

Convert a subset of reStructuredText (RST) to MarkDown (MD).

Parameters:

filename (str | Path) – The path to the reStructuredText (RST) file.

Returns:

The converted data in MarkDown (MD) format.

Return type:

str

previous

deepcave.utils.data_structures

next

deepcave.utils.files