3.2.1.20. sphinx.ext.autodoc.prepare_docstring¶

sphinx.ext.autodoc.prepare_docstring(s, ignore=1)[source]¶

Convert a docstring into lines of parseable reST. Remove common leading indentation, where the indentation of a given number of lines (usually just one) is ignored.

Return the docstring as a list of lines usable for inserting into a docutils ViewList (used as argument of nested_parse().) An empty line is added to act as a separator between this docstring and following content.