0

When using sphinx numpydoc I document the Returns section.

Returns
-------
out: float
    A sentence about the return type

However, rendered this is split into two sections.

Returns:

    out - A sentence about the return type

Return type:

    float

How can I prevent this section to be split and only have a Returns section? Where the Returns section is rendered just as the Parameters section.

If this matters I am using the pydata sphinx theme.

Hielke Walinga
  • 2,677
  • 1
  • 17
  • 30
  • The syntax requires a space on each side of the `:`. Try that. Reference: https://numpydoc.readthedocs.io/en/latest/format.html#parameters – Steve Piercy Jul 15 '23 at 06:15
  • @StevePiercy That does not change anything. Removing out, so just a bare float, will also create a separate Return type section. – Hielke Walinga Jul 17 '23 at 10:16

0 Answers0