This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Display bug in :show-inheritance: for class with standard docstring
Type: behavior Stage:
Components: Documentation tools (Sphinx) Versions: Python 2.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, kumar303
Priority: normal Keywords:

Created on 2008-07-14 19:30 by kumar303, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg69660 - (view) Author: Kumar McMillan (kumar303) Date: 2008-07-14 19:30
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.
msg69997 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-07-18 22:52
Fixed in r65123. Thanks!
History
Date User Action Args
2022-04-11 14:56:36adminsetgithub: 47605
2008-07-18 22:52:45georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg69997
2008-07-14 19:30:41kumar303create