Sphinx Napoleon Extension: document multiple return arguments with Google Style docstrings

Question

This question is related to this other one. The proposed and accepted solution is:

Returns:
       (tuple): tuple containing:                        
                    arg1: First Argument
                    arg2: Second Argument

This solution is not working, at least for me. The indented sub-block with arg1 and arg2 description is not parsed.

How should I manage multiple returns with sphinx, sphinx.ext.napoleon and Google Style docstring?

I think that it's a duplicate of this [post](http://stackoverflow.com/questions/29221551/can-sphinx-napoleon-document-function-returning-multiple-arguments). — Jaime Arias, Dec 06 '16 at 13:52
For posterity, the second, unaccepted answer on the other thread works fine. — lhuber, Apr 10 '18 at 13:28

jaimedash · Answer 1 · 2023-05-03T14:03:38.730

0

This is a known issue that won't be fixed by the sphinx project (current maintainers of napoleon). As mentioned at the link, they don't consider multi-line returns a part of google spec and won't fix this.

edited May 03 '23 at 14:03

answered Mar 14 '17 at 20:35

jaimedash

2,683
17
30

updated the above to point to issue in sphinx repo. they won't fix this – jaimedash May 03 '23 at 14:04

score 0 · Answer 2 · answered Jan 10 '21 at 06:25

0

Try to use use the newline character \n in your docstring:

Returns:
    tuple: tuple containing:

        servers (list): servers to use \n
        msg (str): logging message string

answered Jan 10 '21 at 06:25

huilight

1
1

Sphinx Napoleon Extension: document multiple return arguments with Google Style docstrings

2 Answers2