def test_rst_anon_link_target_missing() -> None: src = """ This link's target is `not defined anywhere`__. """ errors: List[ParseError] = [] parse_docstring(src, errors) assert len(errors) == 1 assert errors[0].descr().startswith("Anonymous hyperlink mismatch:") assert errors[0].is_fatal()
def test_rst_body_nonempty() -> None: src = """ Only body text, no fields. """ errors: List[ParseError] = [] pdoc = parse_docstring(src, errors) assert not errors assert pdoc.has_body assert len(pdoc.fields) == 0
def rst2html( docstring: str, linker: DocstringLinker = NotFoundLinker()) -> str: """ Render a docstring to HTML. """ errors: List[ParseError] = [] parsed = parse_docstring(docstring, errors) assert not errors return flatten(parsed.to_stan(linker))
def test_rst_body_empty() -> None: src = """ :return: a number :rtype: int """ errors: List[ParseError] = [] pdoc = parse_docstring(src, errors) assert not errors assert not pdoc.has_body assert len(pdoc.fields) == 2
def rst2html(s: str) -> str: errors: List[ParseError] = [] parsed = parse_docstring(s, errors) assert not errors return flatten(parsed.to_stan(None))