如何在Python中将作者身份添加到NumPy文档字符串

Question

We switched from Sphinx to style NumPy docstring and .. sectionauthor:: no longer seems to render correctly. Yet, we need to be able to assign an author to each method of a class.

Is there a way to add authorship to NumPy docstring properly?

A naive example:

class A:
    def f(self):
        """ My function

        It does this and that.

        Returns
        -------
        object

        .. sectionauthor:: name of the author

        Examples
        --------
            >>> A().f()

        """
        pass

Compiles into this help doc (notice troubled returns: section):

PS Use of .. sectionauthor:: in NumPy docstring was suggested elsewhere (can't recall the source), so maybe it is simply not used/placed correctly.

Answer 1

figured it out...

First of all, NumPy style documentation discourages addition of authors' info to docstring: " Note that license and author info, while often included in source files, do not belong in docstrings. "

That said, it is not uncommon to identify authors directly in documentation (see any help manual for functions/methods in R language).

Still, shall there be a need to add authors, this can be done with :Authors: reStructured inline markup tag, as following:

:Authors:
    John Doe <John.Doe@email.com>

As discovered, its placement is limited. :Authors: seems to still render docstring correctly, if placed away from descriptions, parameters, and returns sections; for example, after Examples section.

Here is a continued example: