machow/quartodoc

Quartodoc fails to build docs if "\n" included in docstrings

Closed this issue · 1 comments

Building my docstrings through quartodoc seems to fail whenever I inlcude "\n" or "\n" or \n in the docstring. I am not sure how I would best provide a reproducible example, but building the docstrings for this function fails when the "\n"'s are included in the test, and everything works when they are excluded. Please let me know how to best provide you with a reproducible example! The error I get is

in render
    raise NotImplementedError(f"Unsupported DocstringSectionAdmonition kind: {kind}")
NotImplementedError: Unsupported DocstringSectionAdmonition kind:    parameters

Best, Alex

Ah, putting an r before the docstrings solved this, i.e. r"""docstrings with string literal \n""". 😅