Dear list, 
I use the napoleon extension to parse my "numpy-style" docstrings. It works 
great for functions, but for classes, I have the following problem. The 
"Attributes" section list the attributes (as it should), but the header 
"Attributes" does not show. For instance, I get this: 
https://particles-sequential-monte-carlo-in-python.readthedocs.io/en/latest/_autosummary/particles.smoothing.ParticleHistory.html#particles.smoothing.ParticleHistory
(shortened url: https://bit.ly/2IyxR1F) 

where X, A, etc are attributes of this class ParticleHistory. You can click 
on [source] to see how the class is defined; or more simply see below for a 
simplified version. 
Am I doing something wrong? This page:
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/
says that Attributes is a supported header. 

I'm using sphinx 1.8.2 on Ubuntu 18.04. 
Many thanks in advance
Nicolas


class History(object):
    """Stores history.    

    Blah, blah, blah. 

    Attributes
    ----------
    X: list
        X[t] is the object that represents the N particles at iteration t 
    A: list
        A[t] is the vector of ancestor indices at time t

    """

    def __init__(self, N):
        """
        Constructor.

        Parameters
        ----------

        N: int
            number of particles
        """
        self.N = N


-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to