helpers#

sphinx_runpython.process_rst.rst2html(rst: str, writer_name: str = 'html', report_level: int = 0, return_warnings: bool = False, use_sphinx: bool = True, new_extensions: List[str] | None = None, **kwargs) → Tuple[str, str][source]#

Converts a RST string into HTML or RST.

Parameters:

  • rst – RST string

  • report_level – filter output, 0 means everything

  • writer_name – writer name

  • kwargs – additional values to add to the configuration

  • return_warnings – return the warnings as well

  • use_sphinx – run sphinx from the command line and returns the results, for that configuration

  • new_extensions – new extensions to add

Returns:

output and warnings