OiO.lk Community platform!

Oio.lk is an excellent forum for developers, providing a wide range of resources, discussions, and support for those in the developer community. Join oio.lk today to connect with like-minded professionals, share insights, and stay updated on the latest trends and technologies in the development field.
  You need to log in or register to access the solved answers to this problem.
  • You have reached the maximum number of guest views allowed
  • Please register below to remove this limitation

Can I prevent sphinx numpydoc to split the Returns into two sections

  • Thread starter Thread starter Hielke Walinga
  • Start date Start date
H

Hielke Walinga

Guest
When using Sphinx Numpy doc. I document the Returns section.

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

However, rendered this is split into two sections.

Code:
Returns:

    out - A sentence about the return type

Return type:

    float

How can I prevent this section from being split and only having a Returns section? Where the Returns section is rendered just as the Parameters section.

If this matters, I am using the PyData Sphinx theme.
<p>When using Sphinx Numpy doc. I document the Returns section.</p>
<pre><code>Returns
-------
out: float
A sentence about the return type
</code></pre>
<p>However, rendered this is split into two sections.</p>
<pre><code>Returns:

out - A sentence about the return type

Return type:

float
</code></pre>
<p>How can I prevent this section from being split and only having a Returns section? Where the Returns section is rendered just as the Parameters section.</p>
<p>If this matters, I am using the PyData Sphinx theme.</p>
 

Latest posts

O
Replies
0
Views
1
OrangeRind
O
D
Replies
0
Views
2
Domantas Giedraitis
D
Top