nipype.sphinxext.apidoc.docstring module

Reformat interface docstrings.

class nipype.sphinxext.apidoc.docstring.InterfaceDocstring(docstring: unicode | List[unicode], config: SphinxConfig = None, app: Sphinx = None, what: unicode = '', name: unicode = '', obj: Any = None, options: Any = None)

Bases: nipype.sphinxext.apidoc.docstring.NipypeDocstring

Convert docstrings of Nipype Interfaces to reStructuredText.

Parameters:

• docstring (str or list of str) – The docstring to parse, given either as a string or split into individual lines.

• config (sphinx.ext.napoleon.Config or sphinx.config.Config) – The configuration settings to use. If not given, defaults to the config object on app; or if app is not given defaults to the a new nipype.sphinxext.apidoc.Config object.

Other Parameters:

• app (sphinx.application.Sphinx, optional) – Application object representing the Sphinx process.

• what (str, optional) – A string specifying the type of the object to which the docstring belongs. Valid values: “module”, “class”, “exception”, “function”, “method”, “attribute”.

• name (str, optional) – The fully qualified name of the object.

• obj (module, class, exception, function, method, or attribute) – The object to which the docstring belongs.

• options (sphinx.ext.autodoc.Options, optional) – The options given to the directive: an object with attributes inherited_members, undoc_members, show_inheritance and noindex that are True if the flag option of same name was given to the auto directive.

class nipype.sphinxext.apidoc.docstring.NipypeDocstring(docstring: str | list[str], config: SphinxConfig | None = None, app: Sphinx | None = None, what: str = '', name: str = '', obj: Any = None, options: Any = None)

Bases: sphinx.ext.napoleon.docstring.NumpyDocstring

Patch the NumpyDocstring from napoleon to get special section headers.