homepage

Using Sphinx 0.4.1 I noticed a slight display bug in rendering
:show-inheritance: for a class with a PEP 8 / PEP 257 style docstring.
i.e. multi-line docstrings are recommended by the PEPs to look like:
class Foo(SomeFoo):
 """Return a foobang
 Optional plotz says to frobnicate the bizbaz first.
 """
Using Sphinx autodoc extension, the default skin, and...
.. autoclass:: path.to.Foo
 :show-inheritance:
...will show a link to bases but immediately after it (no line break) is
the first line of the doc. This is confusing to read. However,
changing the docstring of the class to add a break like:
class Foo(SomeFoo):
 """
 Return a foobang
 Optional plotz says to frobnicate the bizbaz first.
 """
fixes the problem.

Fixed in r65123. Thanks!