简体   繁体   中英

Why does Sphinx not document my class?

I have a module with 4 classes

class B(object):
    """Docstring for B."""
    pass

class C(B):
    """Docstring for C."""
    pass

class D(B):
    """Docstring for D."""
    pass

class A(object):
    """Docstring for A."""
    c = C()
    d = D()

Only class A is made accessible in the API, together with its attributes c and d (instances of C and D)

The Sphinx generated documentation only shows classes A, C and D

Is that expected behaviour?

There was nothing wrong with Sphinx. The problem was that I had a line of code between the "class" line and the docstring. Now that that I have removed that it works perfectly - embarrassed

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM